臺灣健保事前審查實作指引
1.2.8 - ci-build

臺灣健保事前審查實作指引, published by 衛生福利部中央健康保險署. This guide is not an authorized publication; it is the continuous build for version 1.2.8 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/TWNHIFHIR/pas/ and changes regularly. See the Directory of published versions

Resource Profile: 事前審查回覆-Bundle Response TWPAS

Official URL: https://nhicore.nhi.gov.tw/pas/StructureDefinition/Bundle-response-twpas Version: 1.2.8
Active as of 2026-10-14 Computable Name: BundleResponseTWPAS

此事前審查回覆-Bundle Response TWPAS Profile說明本IG如何進一步定義資料交換基本單位(TW Core Bundle) Profile以呈現回覆事前審查之內容

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle C 0..* TWCoreBundle 包含resourceBundle
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12
Bundle.meta This element is included in summaries. 1..1 Meta 此Bundle Resource的metadata
Bundle.meta.profile This element is included in summaries. 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://nhicore.nhi.gov.tw/pas/StructureDefinition/Bundle-response-twpas
Bundle.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri 創建此內容所依據的一組規則
Bundle.identifier This element must be supported. This element is included in summaries. 0..1 Identifier 一組Resources的資料交換基本單位(Bundle)的識別碼。
Bundle.type This element is included in summaries. 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Bundle類型;應填入所綁定值集中的其中一個代碼。
Required Pattern: searchset
Bundle.timestamp This element must be supported. This element is included in summaries. 0..1 instant 組成Bundle的時間。
Bundle.total This element must be supported. This element is included in summaries. C 0..1 unsignedInt 查詢時符合條件的總筆數
Bundle.link This element is included in summaries. 0..* BackboneElement 與此Bundle相關的連結
Bundle.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.link.relation This element must be supported. This element is included in summaries. 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)
Required Pattern: self
Bundle.link.url This element must be supported. This element is included in summaries. 1..1 uri 連結的參照細節
Bundle.Slices for entry This element must be supported. This element is included in summaries. C 1..* BackboneElement 在bundle中的條目 - 將會有一個resource或資訊,這個重複的資料項目順序:對於type為「document」和「message」的bundles,第一個resource是特殊的(必須分別是Composition或MessageHeader)。對於所有bundles,條目順序的意義取決於bundle的type。
Slice: Unordered, Closed by profile:resource
Constraints: bdl-5, bdl-8
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
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:claimResponse This element must be supported. This element is included in summaries. C 1..1 BackboneElement 事前審查回覆
Constraints: bdl-5, bdl-8
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
Bundle.Slices for entry.entry:claimResponse.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:claimResponse.resource This element must be supported. 1..1 ClaimResponseTWPAS Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Response to a claim predetermination or preauthorization

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.type Base required BundleType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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, Bundle.entry:claimResponse 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, Bundle.entry:claimResponse 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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle 0..* TWCoreBundle 包含resourceBundle
Bundle.meta 1..1 Meta 此Bundle Resource的metadata
Bundle.meta.profile 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
Required Pattern: https://nhicore.nhi.gov.tw/pas/StructureDefinition/Bundle-response-twpas
Bundle.type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Required Pattern: searchset
Bundle.total This element must be supported. 0..1 unsignedInt 查詢時符合條件的總筆數
Bundle.link.relation This element must be supported. 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)
Required Pattern: self
Bundle.link.url This element must be supported. 1..1 uri 連結的參照細節
Bundle.Slices for entry This element must be supported. 1..* BackboneElement 在bundle中的條目 - 將會有一個resource或資訊,這個重複的資料項目順序:對於type為「document」和「message」的bundles,第一個resource是特殊的(必須分別是Composition或MessageHeader)。對於所有bundles,條目順序的意義取決於bundle的type。
Slice: Unordered, Closed by profile:resource
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Bundle.Slices for entry.entry:claimResponse This element must be supported. 1..1 BackboneElement 事前審查回覆
Bundle.Slices for entry.entry:claimResponse.resource This element must be supported. 1..1 ClaimResponseTWPAS Response to a claim predetermination or preauthorization

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle C 0..* TWCoreBundle 包含resourceBundle
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12
Bundle.id This element is included in summaries. 0..1 id 不重複的ID用以識別儲存在特定FHIR Server中的Bundle紀錄,通常又稱為邏輯性ID。
Bundle.meta This element is included in summaries. 1..1 Meta 此Bundle Resource的metadata
Bundle.meta.id 0..1 string Unique id for inter-element referencing
Bundle.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Bundle.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Bundle.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
Bundle.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Bundle.meta.profile This element is included in summaries. 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://nhicore.nhi.gov.tw/pas/StructureDefinition/Bundle-response-twpas
Bundle.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Bundle.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Bundle.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri 創建此內容所依據的一組規則
Bundle.language 0..1 code 用以表述Bundle Resource內容的語言。
Binding: CommonLanguages (preferred): 人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
Additional BindingsPurpose
AllLanguages Max Binding

Example Value: zh-TW
Bundle.identifier This element must be supported. This element is included in summaries. 0..1 Identifier 一組Resources的資料交換基本單位(Bundle)的識別碼。
Bundle.type This element is included in summaries. 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Bundle類型;應填入所綁定值集中的其中一個代碼。
Required Pattern: searchset
Bundle.timestamp This element must be supported. This element is included in summaries. 0..1 instant 組成Bundle的時間。
Bundle.total This element must be supported. This element is included in summaries. C 0..1 unsignedInt 查詢時符合條件的總筆數
Bundle.link This element is included in summaries. 0..* BackboneElement 與此Bundle相關的連結
Bundle.link.id 0..1 string Unique id for inter-element referencing
Bundle.link.extension 0..* Extension Additional content defined by implementations
Bundle.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.link.relation This element must be supported. This element is included in summaries. 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)
Required Pattern: self
Bundle.link.url This element must be supported. This element is included in summaries. 1..1 uri 連結的參照細節
Bundle.Slices for entry This element must be supported. This element is included in summaries. C 1..* BackboneElement 在bundle中的條目 - 將會有一個resource或資訊,這個重複的資料項目順序:對於type為「document」和「message」的bundles,第一個resource是特殊的(必須分別是Composition或MessageHeader)。對於所有bundles,條目順序的意義取決於bundle的type。
Slice: Unordered, Closed by profile:resource
Constraints: bdl-5, bdl-8
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
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.link This element is included in summaries. 0..* See link (Bundle) 與本條目相關的連結
Bundle.Slices for entry.entry:All Slices.fullUrl This element is included in summaries. 0..1 uri Resource的 URI(絕對 URL 伺服器地址或 UUID/OID 的 URI)
Bundle.Slices for entry.entry:All Slices.resource This element is included in summaries. 0..1 Resource Bundle中的resource
Bundle.Slices for entry.entry:All Slices.search This element is included in summaries. C 0..1 BackboneElement 查詢有關的資訊
Bundle.Slices for entry.entry:All Slices.search.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.search.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.search.mode This element is included in summaries. 0..1 code match | include | outcome
Binding: SearchEntryMode (required): Resource出現在Bundle中的原因;應填入所綁定值集中的其中一個代碼。
Bundle.Slices for entry.entry:All Slices.search.score This element is included in summaries. 0..1 decimal 查詢排名(0至1之間)
Bundle.Slices for entry.entry:All Slices.request This element is included in summaries. C 0..1 BackboneElement 其他執行資訊(transaction/batch/history)
Bundle.Slices for entry.entry:All Slices.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.request.method This element is included in summaries. 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): 應填入所綁定值集中的其中一個代碼。
Bundle.Slices for entry.entry:All Slices.request.url This element is included in summaries. 1..1 uri 此Bundle HTTP 對應的 URL
Bundle.Slices for entry.entry:All Slices.request.ifNoneMatch This element is included in summaries. 0..1 string 用於管理緩存當前狀態
Bundle.Slices for entry.entry:All Slices.request.ifModifiedSince This element is included in summaries. 0..1 instant 用於管理緩存當前狀態
Bundle.Slices for entry.entry:All Slices.request.ifMatch This element is included in summaries. 0..1 string 用於管理更新衝突
Bundle.Slices for entry.entry:All Slices.request.ifNoneExist This element is included in summaries. 0..1 string 用於有條件建立
Bundle.Slices for entry.entry:All Slices.response This element is included in summaries. C 0..1 BackboneElement 執行結果(transaction/batch/history)
Bundle.Slices for entry.entry:All Slices.response.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.response.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.response.status This element is included in summaries. 1..1 string 狀態回應代碼(文字選填)
Bundle.Slices for entry.entry:All Slices.response.location This element is included in summaries. 0..1 uri 位置(如果操作返回位置)
Bundle.Slices for entry.entry:All Slices.response.etag This element is included in summaries. 0..1 string resource的 Etag(如果有相關)
Bundle.Slices for entry.entry:All Slices.response.lastModified This element is included in summaries. 0..1 instant 修改時之伺服器日期時間
Bundle.Slices for entry.entry:All Slices.response.outcome This element is included in summaries. 0..1 Resource 帶提示和警告的OperationOutcome(用於batch/transaction)
Bundle.Slices for entry.entry:claimResponse This element must be supported. This element is included in summaries. C 1..1 BackboneElement 事前審查回覆
Constraints: bdl-5, bdl-8
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
Bundle.Slices for entry.entry:claimResponse.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:claimResponse.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:claimResponse.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:claimResponse.link This element is included in summaries. 0..* See link (Bundle) 與本條目相關的連結
Bundle.Slices for entry.entry:claimResponse.fullUrl This element is included in summaries. 0..1 uri Resource的 URI(絕對 URL 伺服器地址或 UUID/OID 的 URI)
Bundle.Slices for entry.entry:claimResponse.resource This element must be supported. 1..1 ClaimResponseTWPAS Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Response to a claim predetermination or preauthorization
Bundle.Slices for entry.entry:claimResponse.search This element is included in summaries. C 0..1 BackboneElement 查詢有關的資訊
Bundle.Slices for entry.entry:claimResponse.search.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:claimResponse.search.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:claimResponse.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:claimResponse.search.mode This element is included in summaries. 0..1 code match | include | outcome
Binding: SearchEntryMode (required): Resource出現在Bundle中的原因;應填入所綁定值集中的其中一個代碼。
Bundle.Slices for entry.entry:claimResponse.search.score This element is included in summaries. 0..1 decimal 查詢排名(0至1之間)
Bundle.Slices for entry.entry:claimResponse.request This element is included in summaries. C 0..1 BackboneElement 其他執行資訊(transaction/batch/history)
Bundle.Slices for entry.entry:claimResponse.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:claimResponse.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:claimResponse.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:claimResponse.request.method This element is included in summaries. 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): 應填入所綁定值集中的其中一個代碼。
Bundle.Slices for entry.entry:claimResponse.request.url This element is included in summaries. 1..1 uri 此Bundle HTTP 對應的 URL
Bundle.Slices for entry.entry:claimResponse.request.ifNoneMatch This element is included in summaries. 0..1 string 用於管理緩存當前狀態
Bundle.Slices for entry.entry:claimResponse.request.ifModifiedSince This element is included in summaries. 0..1 instant 用於管理緩存當前狀態
Bundle.Slices for entry.entry:claimResponse.request.ifMatch This element is included in summaries. 0..1 string 用於管理更新衝突
Bundle.Slices for entry.entry:claimResponse.request.ifNoneExist This element is included in summaries. 0..1 string 用於有條件建立
Bundle.Slices for entry.entry:claimResponse.response This element is included in summaries. C 0..1 BackboneElement 執行結果(transaction/batch/history)
Bundle.Slices for entry.entry:claimResponse.response.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:claimResponse.response.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:claimResponse.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:claimResponse.response.status This element is included in summaries. 1..1 string 狀態回應代碼(文字選填)
Bundle.Slices for entry.entry:claimResponse.response.location This element is included in summaries. 0..1 uri 位置(如果操作返回位置)
Bundle.Slices for entry.entry:claimResponse.response.etag This element is included in summaries. 0..1 string resource的 Etag(如果有相關)
Bundle.Slices for entry.entry:claimResponse.response.lastModified This element is included in summaries. 0..1 instant 修改時之伺服器日期時間
Bundle.Slices for entry.entry:claimResponse.response.outcome This element is included in summaries. 0..1 Resource 帶提示和警告的OperationOutcome(用於batch/transaction)
Bundle.signature This element is included in summaries. 0..1 Signature 數位簽章

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Bundle.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Bundle.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Bundle.type Base required BundleType 📍4.0.1 FHIR Std.
Bundle.entry.search.​mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:claimResponse.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:claimResponse.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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, Bundle.entry:claimResponse 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, Bundle.entry:claimResponse 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

Mandatory: 5 elements
Must-Support: 6 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Bundle.entry (Closed)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle C 0..* TWCoreBundle 包含resourceBundle
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12
Bundle.meta This element is included in summaries. 1..1 Meta 此Bundle Resource的metadata
Bundle.meta.profile This element is included in summaries. 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://nhicore.nhi.gov.tw/pas/StructureDefinition/Bundle-response-twpas
Bundle.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri 創建此內容所依據的一組規則
Bundle.identifier This element must be supported. This element is included in summaries. 0..1 Identifier 一組Resources的資料交換基本單位(Bundle)的識別碼。
Bundle.type This element is included in summaries. 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Bundle類型;應填入所綁定值集中的其中一個代碼。
Required Pattern: searchset
Bundle.timestamp This element must be supported. This element is included in summaries. 0..1 instant 組成Bundle的時間。
Bundle.total This element must be supported. This element is included in summaries. C 0..1 unsignedInt 查詢時符合條件的總筆數
Bundle.link This element is included in summaries. 0..* BackboneElement 與此Bundle相關的連結
Bundle.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.link.relation This element must be supported. This element is included in summaries. 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)
Required Pattern: self
Bundle.link.url This element must be supported. This element is included in summaries. 1..1 uri 連結的參照細節
Bundle.Slices for entry This element must be supported. This element is included in summaries. C 1..* BackboneElement 在bundle中的條目 - 將會有一個resource或資訊,這個重複的資料項目順序:對於type為「document」和「message」的bundles,第一個resource是特殊的(必須分別是Composition或MessageHeader)。對於所有bundles,條目順序的意義取決於bundle的type。
Slice: Unordered, Closed by profile:resource
Constraints: bdl-5, bdl-8
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
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:claimResponse This element must be supported. This element is included in summaries. C 1..1 BackboneElement 事前審查回覆
Constraints: bdl-5, bdl-8
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
Bundle.Slices for entry.entry:claimResponse.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:claimResponse.resource This element must be supported. 1..1 ClaimResponseTWPAS Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Response to a claim predetermination or preauthorization

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.type Base required BundleType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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, Bundle.entry:claimResponse 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, Bundle.entry:claimResponse 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()

Differential View

This structure is derived from TWCoreBundle

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle 0..* TWCoreBundle 包含resourceBundle
Bundle.meta 1..1 Meta 此Bundle Resource的metadata
Bundle.meta.profile 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
Required Pattern: https://nhicore.nhi.gov.tw/pas/StructureDefinition/Bundle-response-twpas
Bundle.type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Required Pattern: searchset
Bundle.total This element must be supported. 0..1 unsignedInt 查詢時符合條件的總筆數
Bundle.link
Bundle.link.relation This element must be supported. 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)
Required Pattern: self
Bundle.link.url This element must be supported. 1..1 uri 連結的參照細節
Bundle.Slices for entry This element must be supported. 1..* BackboneElement 在bundle中的條目 - 將會有一個resource或資訊,這個重複的資料項目順序:對於type為「document」和「message」的bundles,第一個resource是特殊的(必須分別是Composition或MessageHeader)。對於所有bundles,條目順序的意義取決於bundle的type。
Slice: Unordered, Closed by profile:resource
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Bundle.Slices for entry.entry:claimResponse This element must be supported. 1..1 BackboneElement 事前審查回覆
Bundle.Slices for entry.entry:claimResponse.resource This element must be supported. 1..1 ClaimResponseTWPAS Response to a claim predetermination or preauthorization

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle C 0..* TWCoreBundle 包含resourceBundle
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12
Bundle.id This element is included in summaries. 0..1 id 不重複的ID用以識別儲存在特定FHIR Server中的Bundle紀錄,通常又稱為邏輯性ID。
Bundle.meta This element is included in summaries. 1..1 Meta 此Bundle Resource的metadata
Bundle.meta.id 0..1 string Unique id for inter-element referencing
Bundle.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Bundle.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Bundle.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
Bundle.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Bundle.meta.profile This element is included in summaries. 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://nhicore.nhi.gov.tw/pas/StructureDefinition/Bundle-response-twpas
Bundle.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Bundle.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Bundle.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri 創建此內容所依據的一組規則
Bundle.language 0..1 code 用以表述Bundle Resource內容的語言。
Binding: CommonLanguages (preferred): 人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
Additional BindingsPurpose
AllLanguages Max Binding

Example Value: zh-TW
Bundle.identifier This element must be supported. This element is included in summaries. 0..1 Identifier 一組Resources的資料交換基本單位(Bundle)的識別碼。
Bundle.type This element is included in summaries. 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Bundle類型;應填入所綁定值集中的其中一個代碼。
Required Pattern: searchset
Bundle.timestamp This element must be supported. This element is included in summaries. 0..1 instant 組成Bundle的時間。
Bundle.total This element must be supported. This element is included in summaries. C 0..1 unsignedInt 查詢時符合條件的總筆數
Bundle.link This element is included in summaries. 0..* BackboneElement 與此Bundle相關的連結
Bundle.link.id 0..1 string Unique id for inter-element referencing
Bundle.link.extension 0..* Extension Additional content defined by implementations
Bundle.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.link.relation This element must be supported. This element is included in summaries. 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)
Required Pattern: self
Bundle.link.url This element must be supported. This element is included in summaries. 1..1 uri 連結的參照細節
Bundle.Slices for entry This element must be supported. This element is included in summaries. C 1..* BackboneElement 在bundle中的條目 - 將會有一個resource或資訊,這個重複的資料項目順序:對於type為「document」和「message」的bundles,第一個resource是特殊的(必須分別是Composition或MessageHeader)。對於所有bundles,條目順序的意義取決於bundle的type。
Slice: Unordered, Closed by profile:resource
Constraints: bdl-5, bdl-8
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
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.link This element is included in summaries. 0..* See link (Bundle) 與本條目相關的連結
Bundle.Slices for entry.entry:All Slices.fullUrl This element is included in summaries. 0..1 uri Resource的 URI(絕對 URL 伺服器地址或 UUID/OID 的 URI)
Bundle.Slices for entry.entry:All Slices.resource This element is included in summaries. 0..1 Resource Bundle中的resource
Bundle.Slices for entry.entry:All Slices.search This element is included in summaries. C 0..1 BackboneElement 查詢有關的資訊
Bundle.Slices for entry.entry:All Slices.search.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.search.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.search.mode This element is included in summaries. 0..1 code match | include | outcome
Binding: SearchEntryMode (required): Resource出現在Bundle中的原因;應填入所綁定值集中的其中一個代碼。
Bundle.Slices for entry.entry:All Slices.search.score This element is included in summaries. 0..1 decimal 查詢排名(0至1之間)
Bundle.Slices for entry.entry:All Slices.request This element is included in summaries. C 0..1 BackboneElement 其他執行資訊(transaction/batch/history)
Bundle.Slices for entry.entry:All Slices.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.request.method This element is included in summaries. 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): 應填入所綁定值集中的其中一個代碼。
Bundle.Slices for entry.entry:All Slices.request.url This element is included in summaries. 1..1 uri 此Bundle HTTP 對應的 URL
Bundle.Slices for entry.entry:All Slices.request.ifNoneMatch This element is included in summaries. 0..1 string 用於管理緩存當前狀態
Bundle.Slices for entry.entry:All Slices.request.ifModifiedSince This element is included in summaries. 0..1 instant 用於管理緩存當前狀態
Bundle.Slices for entry.entry:All Slices.request.ifMatch This element is included in summaries. 0..1 string 用於管理更新衝突
Bundle.Slices for entry.entry:All Slices.request.ifNoneExist This element is included in summaries. 0..1 string 用於有條件建立
Bundle.Slices for entry.entry:All Slices.response This element is included in summaries. C 0..1 BackboneElement 執行結果(transaction/batch/history)
Bundle.Slices for entry.entry:All Slices.response.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.response.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.response.status This element is included in summaries. 1..1 string 狀態回應代碼(文字選填)
Bundle.Slices for entry.entry:All Slices.response.location This element is included in summaries. 0..1 uri 位置(如果操作返回位置)
Bundle.Slices for entry.entry:All Slices.response.etag This element is included in summaries. 0..1 string resource的 Etag(如果有相關)
Bundle.Slices for entry.entry:All Slices.response.lastModified This element is included in summaries. 0..1 instant 修改時之伺服器日期時間
Bundle.Slices for entry.entry:All Slices.response.outcome This element is included in summaries. 0..1 Resource 帶提示和警告的OperationOutcome(用於batch/transaction)
Bundle.Slices for entry.entry:claimResponse This element must be supported. This element is included in summaries. C 1..1 BackboneElement 事前審查回覆
Constraints: bdl-5, bdl-8
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
Bundle.Slices for entry.entry:claimResponse.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:claimResponse.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:claimResponse.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:claimResponse.link This element is included in summaries. 0..* See link (Bundle) 與本條目相關的連結
Bundle.Slices for entry.entry:claimResponse.fullUrl This element is included in summaries. 0..1 uri Resource的 URI(絕對 URL 伺服器地址或 UUID/OID 的 URI)
Bundle.Slices for entry.entry:claimResponse.resource This element must be supported. 1..1 ClaimResponseTWPAS Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Response to a claim predetermination or preauthorization
Bundle.Slices for entry.entry:claimResponse.search This element is included in summaries. C 0..1 BackboneElement 查詢有關的資訊
Bundle.Slices for entry.entry:claimResponse.search.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:claimResponse.search.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:claimResponse.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:claimResponse.search.mode This element is included in summaries. 0..1 code match | include | outcome
Binding: SearchEntryMode (required): Resource出現在Bundle中的原因;應填入所綁定值集中的其中一個代碼。
Bundle.Slices for entry.entry:claimResponse.search.score This element is included in summaries. 0..1 decimal 查詢排名(0至1之間)
Bundle.Slices for entry.entry:claimResponse.request This element is included in summaries. C 0..1 BackboneElement 其他執行資訊(transaction/batch/history)
Bundle.Slices for entry.entry:claimResponse.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:claimResponse.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:claimResponse.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:claimResponse.request.method This element is included in summaries. 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): 應填入所綁定值集中的其中一個代碼。
Bundle.Slices for entry.entry:claimResponse.request.url This element is included in summaries. 1..1 uri 此Bundle HTTP 對應的 URL
Bundle.Slices for entry.entry:claimResponse.request.ifNoneMatch This element is included in summaries. 0..1 string 用於管理緩存當前狀態
Bundle.Slices for entry.entry:claimResponse.request.ifModifiedSince This element is included in summaries. 0..1 instant 用於管理緩存當前狀態
Bundle.Slices for entry.entry:claimResponse.request.ifMatch This element is included in summaries. 0..1 string 用於管理更新衝突
Bundle.Slices for entry.entry:claimResponse.request.ifNoneExist This element is included in summaries. 0..1 string 用於有條件建立
Bundle.Slices for entry.entry:claimResponse.response This element is included in summaries. C 0..1 BackboneElement 執行結果(transaction/batch/history)
Bundle.Slices for entry.entry:claimResponse.response.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:claimResponse.response.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:claimResponse.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:claimResponse.response.status This element is included in summaries. 1..1 string 狀態回應代碼(文字選填)
Bundle.Slices for entry.entry:claimResponse.response.location This element is included in summaries. 0..1 uri 位置(如果操作返回位置)
Bundle.Slices for entry.entry:claimResponse.response.etag This element is included in summaries. 0..1 string resource的 Etag(如果有相關)
Bundle.Slices for entry.entry:claimResponse.response.lastModified This element is included in summaries. 0..1 instant 修改時之伺服器日期時間
Bundle.Slices for entry.entry:claimResponse.response.outcome This element is included in summaries. 0..1 Resource 帶提示和警告的OperationOutcome(用於batch/transaction)
Bundle.signature This element is included in summaries. 0..1 Signature 數位簽章

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Bundle.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Bundle.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Bundle.type Base required BundleType 📍4.0.1 FHIR Std.
Bundle.entry.search.​mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:claimResponse.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:claimResponse.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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, Bundle.entry:claimResponse 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, Bundle.entry:claimResponse 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

Mandatory: 5 elements
Must-Support: 6 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Bundle.entry (Closed)

 

Other representations of profile: CSV, Excel, Schematron

Notes:

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

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

  1. 必須(SHALL) 支援透過查詢參數 _id 查詢所有Bundle:
    (如何透過token查詢)
    GET [base]/Bundle?_id=[id]
    GET [base]/Bundle/[id]

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