臺灣核心實作指引(TW Core IG), published by 衛生福利部. This guide is not an authorized publication; it is the continuous build for version 0.3.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/cctwFHIRterm/MOHW_TWCoreIG_Build/ and changes regularly. See the Directory of published versions
Official URL: https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Bundle-twcore | Version: 0.3.2 | |||
Active as of 2024-12-20 | Computable Name: TWCoreBundle |
此臺灣核心-資料交換基本單位(TW Core Bundle) Profile說明本IG如何進一步定義FHIR的Bundle Resource以呈現資料交換基本單位的詳細資料。
一個用於儲存一組resources的容器(container)。
常見的操作是將一堆 resources 集合在一起,放到一個單獨的地方,同時保留它們的相關訊息。在 FHIR 中,這個操作叫做「bundling resources」。這樣做對於很多不同的情境都很有用,例如:
有兩種方式可以將 resources 聚集在一起以便於傳輸和永久化:分別為「內嵌的resources」和「bundles」。兩者之間有一個重要的區別:
除了這兩種技術機制之外,還有三種行政和基礎建設的 resources ,也支援內容的分組(grouping)。這些 resources 不直接包含其他 resources ,而是使用「Reference」來指向被分組的resources:
sections
)的焦點(focus
)。這三個 resources 代表它們所參照的 resources 的有意義的分組(例如:一個出院用藥的List,一個臨床試驗參與者的Group,一組已簽名文件的resources),而一個bundle僅僅是用於傳輸和儲存的 resources 的容器。這些未必詳盡,其他的 resources 也提供了群組功能。
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Bundle
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Bundle | 0..* | Bundle | 包含resourceBundle | |||||
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代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
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 |
Path | Conformance | ValueSet | URI | |||
Bundle.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Bundle.type | required | BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard | ||||
Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard | ||||
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Bundle | C | 0..* | Bundle | 包含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。 | ||||
meta | Σ | 0..1 | Meta | 此Bundle Resource的metadata ele-1: All FHIR elements must have a @value or children | ||||
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 ele-1: All FHIR elements must have a @value or children | ||||
language | 0..1 | code | 用以表述Bundle Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
ele-1: All FHIR elements must have a @value or children Example Value: zh-TW | |||||
identifier | SΣ | 0..1 | Identifier | 一組Resources的資料交換基本單位(Bundle)的識別碼。 ele-1: All FHIR elements must have a @value or children | ||||
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Bundle類型;應填入所綁定值集中的其中一個代碼。 ele-1: All FHIR elements must have a @value or children | ||||
timestamp | SΣ | 0..1 | instant | 組成Bundle的時間。 ele-1: All FHIR elements must have a @value or children | ||||
total | ΣC | 0..1 | unsignedInt | 查詢時符合條件的總筆數 ele-1: All FHIR elements must have a @value or children | ||||
link | Σ | 0..* | BackboneElement | 與此Bundle相關的連結 ele-1: All FHIR elements must have a @value or children | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
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) ele-1: All FHIR elements must have a @value or children | ||||
url | Σ | 1..1 | uri | 連結的參照細節 ele-1: All FHIR elements must have a @value or children | ||||
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 ele-1: All FHIR elements must have a @value or children This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
link | Σ | 0..* | See link (Bundle) | 與本條目相關的連結 ele-1: All FHIR elements must have a @value or children | ||||
fullUrl | Σ | 0..1 | uri | Resource的 URI(絕對 URL 伺服器地址或 UUID/OID 的 URI) ele-1: All FHIR elements must have a @value or children | ||||
resource | Σ | 0..1 | Resource | Bundle中的resource | ||||
search | ΣC | 0..1 | BackboneElement | 查詢有關的資訊 ele-1: All FHIR elements must have a @value or children | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
mode | Σ | 0..1 | code | match | include | outcome Binding: SearchEntryMode (required): Resource出現在Bundle中的原因;應填入所綁定值集中的其中一個代碼。 ele-1: All FHIR elements must have a @value or children | ||||
score | Σ | 0..1 | decimal | 查詢排名(0至1之間) ele-1: All FHIR elements must have a @value or children | ||||
request | ΣC | 0..1 | BackboneElement | 其他執行資訊(transaction/batch/history) ele-1: All FHIR elements must have a @value or children | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): 應填入所綁定值集中的其中一個代碼。 ele-1: All FHIR elements must have a @value or children | ||||
url | Σ | 1..1 | uri | 此Bundle HTTP 對應的 URL ele-1: All FHIR elements must have a @value or children | ||||
ifNoneMatch | Σ | 0..1 | string | 用於管理緩存當前狀態 ele-1: All FHIR elements must have a @value or children | ||||
ifModifiedSince | Σ | 0..1 | instant | 用於管理緩存當前狀態 ele-1: All FHIR elements must have a @value or children | ||||
ifMatch | Σ | 0..1 | string | 用於管理更新衝突 ele-1: All FHIR elements must have a @value or children | ||||
ifNoneExist | Σ | 0..1 | string | 用於有條件建立 ele-1: All FHIR elements must have a @value or children | ||||
response | ΣC | 0..1 | BackboneElement | 執行結果(transaction/batch/history) ele-1: All FHIR elements must have a @value or children | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
status | Σ | 1..1 | string | 狀態回應代碼(文字選填) ele-1: All FHIR elements must have a @value or children | ||||
location | Σ | 0..1 | uri | 位置(如果操作返回位置) ele-1: All FHIR elements must have a @value or children | ||||
etag | Σ | 0..1 | string | resource的 Etag(如果有相關) ele-1: All FHIR elements must have a @value or children | ||||
lastModified | Σ | 0..1 | instant | 修改時之伺服器日期時間 ele-1: All FHIR elements must have a @value or children | ||||
outcome | Σ | 0..1 | Resource | 帶提示和警告的OperationOutcome(用於batch/transaction) | ||||
signature | Σ | 0..1 | Signature | 數位簽章 ele-1: All FHIR elements must have a @value or children | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Bundle.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Bundle.type | required | BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard | ||||
Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard | ||||
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard |
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..* | Bundle | 包含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。 | ||||
meta | Σ | 0..1 | Meta | 此Bundle Resource的metadata | ||||
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 | ||||
language | 0..1 | code | 用以表述Bundle Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
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 | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 |
Path | Conformance | ValueSet | URI | |||
Bundle.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Bundle.type | required | BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard | ||||
Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard | ||||
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard |
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 Bundle
Differential View
This structure is derived from Bundle
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Bundle | 0..* | Bundle | 包含resourceBundle | |||||
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代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
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 |
Path | Conformance | ValueSet | URI | |||
Bundle.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Bundle.type | required | BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard | ||||
Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard | ||||
Bundle.entry.request.method | required | HTTPVerbhttp://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..* | Bundle | 包含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。 | ||||
meta | Σ | 0..1 | Meta | 此Bundle Resource的metadata ele-1: All FHIR elements must have a @value or children | ||||
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 ele-1: All FHIR elements must have a @value or children | ||||
language | 0..1 | code | 用以表述Bundle Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
ele-1: All FHIR elements must have a @value or children Example Value: zh-TW | |||||
identifier | SΣ | 0..1 | Identifier | 一組Resources的資料交換基本單位(Bundle)的識別碼。 ele-1: All FHIR elements must have a @value or children | ||||
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Bundle類型;應填入所綁定值集中的其中一個代碼。 ele-1: All FHIR elements must have a @value or children | ||||
timestamp | SΣ | 0..1 | instant | 組成Bundle的時間。 ele-1: All FHIR elements must have a @value or children | ||||
total | ΣC | 0..1 | unsignedInt | 查詢時符合條件的總筆數 ele-1: All FHIR elements must have a @value or children | ||||
link | Σ | 0..* | BackboneElement | 與此Bundle相關的連結 ele-1: All FHIR elements must have a @value or children | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
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) ele-1: All FHIR elements must have a @value or children | ||||
url | Σ | 1..1 | uri | 連結的參照細節 ele-1: All FHIR elements must have a @value or children | ||||
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 ele-1: All FHIR elements must have a @value or children This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
link | Σ | 0..* | See link (Bundle) | 與本條目相關的連結 ele-1: All FHIR elements must have a @value or children | ||||
fullUrl | Σ | 0..1 | uri | Resource的 URI(絕對 URL 伺服器地址或 UUID/OID 的 URI) ele-1: All FHIR elements must have a @value or children | ||||
resource | Σ | 0..1 | Resource | Bundle中的resource | ||||
search | ΣC | 0..1 | BackboneElement | 查詢有關的資訊 ele-1: All FHIR elements must have a @value or children | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
mode | Σ | 0..1 | code | match | include | outcome Binding: SearchEntryMode (required): Resource出現在Bundle中的原因;應填入所綁定值集中的其中一個代碼。 ele-1: All FHIR elements must have a @value or children | ||||
score | Σ | 0..1 | decimal | 查詢排名(0至1之間) ele-1: All FHIR elements must have a @value or children | ||||
request | ΣC | 0..1 | BackboneElement | 其他執行資訊(transaction/batch/history) ele-1: All FHIR elements must have a @value or children | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): 應填入所綁定值集中的其中一個代碼。 ele-1: All FHIR elements must have a @value or children | ||||
url | Σ | 1..1 | uri | 此Bundle HTTP 對應的 URL ele-1: All FHIR elements must have a @value or children | ||||
ifNoneMatch | Σ | 0..1 | string | 用於管理緩存當前狀態 ele-1: All FHIR elements must have a @value or children | ||||
ifModifiedSince | Σ | 0..1 | instant | 用於管理緩存當前狀態 ele-1: All FHIR elements must have a @value or children | ||||
ifMatch | Σ | 0..1 | string | 用於管理更新衝突 ele-1: All FHIR elements must have a @value or children | ||||
ifNoneExist | Σ | 0..1 | string | 用於有條件建立 ele-1: All FHIR elements must have a @value or children | ||||
response | ΣC | 0..1 | BackboneElement | 執行結果(transaction/batch/history) ele-1: All FHIR elements must have a @value or children | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
status | Σ | 1..1 | string | 狀態回應代碼(文字選填) ele-1: All FHIR elements must have a @value or children | ||||
location | Σ | 0..1 | uri | 位置(如果操作返回位置) ele-1: All FHIR elements must have a @value or children | ||||
etag | Σ | 0..1 | string | resource的 Etag(如果有相關) ele-1: All FHIR elements must have a @value or children | ||||
lastModified | Σ | 0..1 | instant | 修改時之伺服器日期時間 ele-1: All FHIR elements must have a @value or children | ||||
outcome | Σ | 0..1 | Resource | 帶提示和警告的OperationOutcome(用於batch/transaction) | ||||
signature | Σ | 0..1 | Signature | 數位簽章 ele-1: All FHIR elements must have a @value or children | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Bundle.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Bundle.type | required | BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard | ||||
Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard | ||||
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard |
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..* | Bundle | 包含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。 | ||||
meta | Σ | 0..1 | Meta | 此Bundle Resource的metadata | ||||
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 | ||||
language | 0..1 | code | 用以表述Bundle Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
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 | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 |
Path | Conformance | ValueSet | URI | |||
Bundle.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Bundle.type | required | BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard | ||||
Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard | ||||
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard |
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 Bundle
Other representations of profile: CSV, Excel, Schematron
以下概述了此Profile所需的RESTful FHIR互動功能。有關TW Core IG支援的RESTful互動功能的完整清單,請參閱TW Core Server能力聲明。
建議應該(SHOULD) 支援透過查詢參數 _id
查詢所有Bundle:
(如何透過token查詢)
GET [base]/Bundle?_id=[id]
GET [base]/Bundle/[id]
例子:
(1) GET [base]/Bundle?_id=bun-example
(2) GET [base]/Bundle/bun-example
建議應該(SHOULD) 支援透過查詢參數 identifier
查詢所有Bundle:
(如何透過token查詢)
GET [base]/Bundle?identifier={system|}[code]
例子:
(1) GET [base]/Bundle?identifier=https://www.cdc.gov.tw/|01014857930415100059403