TW Core Bundle Document - 臺灣核心實作指引(TW Core IG) v0.2.0

Pattern: document

http://hl7.org/fhir/ValueSet/bundle-type|4.0.1

from the FHIR Standard

Bundle.entry.search.mode

http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1

from the FHIR Standard

Bundle.entry.request.method

http://hl7.org/fhir/ValueSet/http-verb|4.0.1

from the FHIR Standard

Bundle.entry:TWCoreComposition.search.mode

http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1

from the FHIR Standard

Bundle.entry:TWCoreComposition.request.method

Description & Constraints

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, Bundle.entry:TWCoreComposition	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:TWCoreComposition	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: 4 elements
Must-Support: 1 element

Structures

This structure refers to these other structures:

TW Core Composition (https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Composition-twcore)

Slices

This structure defines the following Slices:

The element Bundle.entry is sliced based on the value of profile:resource

Differential View

This structure is derived from TWCoreBundle

Name	Flags	Card.	Type	Description & Constraints
Bundle		0..*	TWCoreBundle	包含resourceBundle
identifier		1..1	Identifier	一組Resources的資料交換基本單位（Bundle）的識別碼。
type		1..1	code	document \| message \| transaction \| transaction-response \| batch \| batch-response \| history \| searchset \| collection Required Pattern: document
timestamp		1..1	instant	組成Bundle的時間。
Slices for entry		1..*	BackboneElement	在bundle中的條目 - 將會有一個resource或資訊，這個重複的資料項目順序：對於type為「document」和「message」的bundles，第一個resource是特殊的（必須分別是Composition或MessageHeader）。對於所有bundles，條目順序的意義取決於bundle的type。 Slice: Unordered, Open by profile:resource
entry:TWCoreComposition	S	1..1	BackboneElement	在bundle中的條目 - 將會有一個resource或資訊，這個重複的資料項目順序：對於type為「document」和「message」的bundles，第一個resource是特殊的（必須分別是Composition或MessageHeader）。對於所有bundles，條目順序的意義取決於bundle的type。
resource		0..1	TWCoreComposition	將一組resources組成一份連貫的臨床聲明，並附有臨床證明。
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
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	創建此內容所依據的一組規則
identifier	SΣ	1..1	Identifier	一組Resources的資料交換基本單位（Bundle）的識別碼。
type	Σ	1..1	code	document \| message \| transaction \| transaction-response \| batch \| batch-response \| history \| searchset \| collection Binding: BundleType (required): Bundle類型；應填入所綁定值集中的其中一個代碼。 Required Pattern: document
timestamp	SΣ	1..1	instant	組成Bundle的時間。
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 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	此擴充的資料項目可能會完全修正或改變其他資料項目的意涵，需特別留意。
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 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	此擴充的資料項目可能會完全修正或改變其他資料項目的意涵，需特別留意。
resource		0..1	TWCoreComposition	將一組resources組成一份連貫的臨床聲明，並附有臨床證明。
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.type	required	Pattern: document `http://hl7.org/fhir/ValueSet/bundle-type\|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, Bundle.entry:TWCoreComposition	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:TWCoreComposition	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

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

id

Σ

0..1

id

不重複的ID用以識別儲存在特定FHIR Server中的Bundle紀錄，通常又稱為邏輯性ID。

Terminology Bindings

Path Conformance ValueSet / Code URI

Bundle.language

preferred

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Bundle.type

Pattern: document

http://hl7.org/fhir/ValueSet/bundle-type|4.0.1

from the FHIR Standard

Bundle.entry.search.mode

http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1

from the FHIR Standard

Bundle.entry.request.method

http://hl7.org/fhir/ValueSet/http-verb|4.0.1

from the FHIR Standard

Bundle.entry:TWCoreComposition.search.mode

http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1

from the FHIR Standard

Bundle.entry:TWCoreComposition.request.method