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

This page is part of the 臺灣核心實作指引(TW Core IG) (v0.2.2: Releases) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: TWCoreBundle - Detailed Descriptions

Active as of 2024-05-28

Definitions for the Bundle-twcore resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Bundle
Definition

用於存於一組Resources的結構或物件

Short包含resourceBundle
2. Bundle.id
Definition

resource的邏輯ID,在resource的URL中使用。一旦指定,這個值永遠不會改變。

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

一個resource使用新增操作(create operation)提交給伺服器時,此resource沒有id,它的id在resource被創建後由伺器分配/指定。

4. Bundle.meta
Definition

關於resource的metadata。這是由基礎建設維護的內容。內容的更改可能並不總是與resource的版本更改相關聯。

Short此Bundle Resource的metadata
6. Bundle.implicitRules
Definition

構建resource時遵循的一系列規則的參照,在處理內容時必須理解這些規則。通常這是對IG所定義之特殊規則及其他profiles的參照。

Short創建此內容所依據的一組規則
Comments

宣告這套規則限制了內容只能被有限的交易夥伴所理解。這從本質上限制了資料的長期有用性。然而,現有的健康生態體系高度分裂,還沒有準備好以普遍可計算的方式定義、收集和交換資料。只要有可能,實作者和/或規範編寫者應該避免使用這個資料項目。通常在使用時,此URL是對IG的參照,此IG將這些特殊規則與其他profiles、value sets等一起定義為其敘述的一部分。

8. Bundle.language
Definition

編寫此resource的語言

Short用以表述Bundle Resource內容的語言。
Comments

提供語言是為了支援索引和可存取性(通常,文字表述轉語音等服務使用此語言標籤)。html lanuage tag適用於此敘述。resource上的語言標籤可用於指定從resource中的資料所產成的其他表述之語言。不是所有的內容都必須使用此語言。不應該假定Resource.language自動適用於敘述。如果指定語言,它也應該被指定在html中的div資料項目(關於xml:lang和html lang屬性之間的關係,見HTML5中的規則)。

BindingThe codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages)

人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。

Additional BindingsPurpose
AllLanguagesMax Binding
Example<br/><b>Value</b>:zh-TW
10. Bundle.identifier
Definition

Bundle的永久識別碼,識別碼不會因為Bundle從一個伺服器複製到另一個伺服器而改變。。

Short一組Resources的資料交換基本單位(Bundle)的識別碼。
Comments

永久的識別通常只對Document、Message和Collection的批次處理是重要。它通常不會被填入到searh和history的結果中,伺服器在處理batches和transactions時會忽略Bundle.identifier。但對於Documents的identifier 必須(SHALL) 被填入,其為全球唯一的識別碼。

NoteThis is a business identifier, not a resource identifier (see discussion)
Must Supporttrue
12. Bundle.type
Definition

表明這個Bundle的目的-期望如何使用。

Comments

Bundle也可以用於其他目的(例如,document可以作為transaction被接受)。這主要是為了給某些Bundle類型制定特定的規則。

BindingThe codes SHALL be taken from BundleType
(required to http://hl7.org/fhir/ValueSet/bundle-type|4.0.1)

Bundle類型;應填入所綁定值集中的其中一個代碼。

14. Bundle.timestamp
Definition

Bundle組裝的日期/時間 - 也就是resources被放入Bundle的時間。

Short組成Bundle的時間。
Comments

對很多Bundle而言,時間戳記同等於.meta.lastUpdated,因為它們不會被儲存(例如:查詢結果)。當一個Bundl被放置在一個持久化存儲中(a persistent store)時,.meta.lastUpdated通常會被伺服器改變。當Bundle是一個Message時,中介軟體(即使沒有存儲)**建議應該(SHOULD)更新.meta.lastUpdated。.timestamp用於追踪Bundle的原始時間,並且建議應該(SHOULD)**被填入。

使用方法:

  • document : 文件的創建日期。注意:composition的創建可能早於Bundle的創鍵,或者composition會與多個文件相關聯。composition的編輯日期可能早於Bundle的組成時間。
  • mssage:訊息內容被組成的日期。這個日期不會被中介軟體引擎改變,除非他們增加了額外的資料,改變了訊息的時間含義。
  • history : 歷史紀錄被組成的日期。這個時間將被用於查詢_since(自此)時間後的後續更新紀錄。
  • searchset : 查詢結果集:是指查詢結果組合起來的時間。要注意的是,不同的頁面**可能(MAY)**會有不同的時間標記,但不是必須的。即使時間標記不同,也不代表隨後的頁面會顯示或包含從最初查詢後所做的變更。

transaction | transaction-response | batch | batch-response | collection : 沒有特別指定的含義。 時間戳記的值應該比Bundle中的resources的 lastUpdated 和其他時間戳記還要新,而且應該等於或早於Bundle本身的 .meta.lastUpdated 相同或更早。

Must Supporttrue
16. Bundle.total
Definition

如果有一組查詢結果相符,這個數字代表所有頁面中 type「match」條目的總數。這個總數不包括search.mode=「include」 或 「outcome」的查詢結果,也不表示Bundle內全部條目的數量。

Short查詢時符合條件的總筆數
Comments

只在Bundle是查詢結果集時使用。這個總數不包括像是OperationOutcome和Bundle中包含的resources等,只計算匹配的resources的總數。

18. Bundle.link
Definition

一系列連結,為這個Bundle提供上下文。

Short與此Bundle相關的連結
Comments

Bundle.link和Bundle.entry.link的設計是為了在使用Bundle時(例如實現HATEOAS時)提供更多的上下文資訊。

如果entry中的resource是直接被讀取的,那麼Bundle.entry.link就對應於HTTP header中的連結。

雖然這個規範對於查詢和分頁有一些Bundle.link的特定使用方式,但對於Bundle.entry.link沒有特定的使用方式,也沒有在transaction過程中定義其功能 - 它的具體意義取決於實際的應用方式。

20. Bundle.link.relation
Definition

詳細說明該連結功能用途的名稱 - 參見http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1

Short參見 [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)
22. Bundle.link.url
Definition

連結的參照細節

Short連結的參照細節
24. Bundle.entry
Definition

Bundle resource中的條目 - 將包含一個resource或是關於resource的資訊(僅限transactions和history)。

Short在bundle中的條目 - 將會有一個resource或資訊,這個重複的資料項目順序:對於type為「document」和「message」的bundles,第一個resource是特殊的(必須分別是Composition或MessageHeader)。對於所有bundles,條目順序的意義取決於bundle的type。
26. Bundle.entry.link
Definition

為本條目提供情境背景的一系列連結。

Short與本條目相關的連結
28. Bundle.entry.fullUrl
Definition

resource的絕對URL。fullUrl **必須沒有(SHALL NOT)**與resource中的 id 不一致,也就是說如果 fullUrl 不是 urn:uuid,則 URL 應為與 Resource.id 一致的不分版本的URL。fullUrl 是對resource的不分版本參照。fullUrl 資料項目必須有一個值,但以下情況除外:

在 POST 時,fullUrl 可以為空(雖然在 bundle 中包含暫時 id 時,fullUrl 不需要為空) 操作結果可能涉及未被識別的resources。

ShortResource的 URI(絕對 URL 伺服器地址或 UUID/OID 的 URI)
Comments

fullUrl 在resource上下文中可能不是唯一的。請注意:由於 FHIR resource不需要透過 FHIR API 提供服務,因此 fullURL 可能是一個 URN 或絕對 URL,而不是以resource的邏輯 id(Resource.id)結尾。但是,如果 fullUrl 看起來確實像 RESTful 伺服器 URL(例如:符合正則表達式regex,則 fullUrl 的 「id」部分 必須(SHALL) 以 Resource.id 結尾。

請注意:fullUrl 與 canonical URL(正準URL) 並不相同,fullUrl是為resource提供服務的端點的絕對 URL(這些在為 resource 帶有 canonical URL 的 Canonical 伺服器上將具有相同的值)。

30. Bundle.entry.resource
Definition

Bundle中的resource。resource的目的/含義由 Bundle.type 決定。

ShortBundle中的resource
32. Bundle.entry.search
Definition

有關如何進行查詢才能創建此條目的解釋資訊。

Short查詢有關的資訊
34. Bundle.entry.search.mode
Definition

此條目出現在結果集中的原因--是因為符合match要求還是因為 _include 要求,或者是為了傳達有關查詢過程的資訊或警告資訊。

Shortmatch | include | outcome
Comments

只有一種模式。在某些情況下,一個resource可能會被包含,因為它既是match也是include的resource。在這種情況下,「match」優先。

BindingThe codes SHALL be taken from SearchEntryMode
(required to http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1)

Resource出現在Bundle中的原因;應填入所綁定值集中的其中一個代碼。

36. Bundle.entry.search.score
Definition

查詢時,該條目在伺服器上的查詢排名得分。

Short查詢排名(0至1之間)
Comments

伺服器無需返回排名得分,1 表示最相關,0 表示最不相關。通常情況下,查詢結果按得分排序,但用戶可指定不同的排序順序。

請參閱「病人匹配(Patient Match)」以了解與此資料項目相關的 EMPI 查詢。請參閱[Patient Match](http://hl7.org/fhir/R4/patient-operation-match.html),了解與此要素相關的 EMPI 查詢。

38. Bundle.entry.request
Definition

關於如何將條目作為transaction或batch的一部分進行處理的附加資訊。對於history,它顯示如何處理條目以創建條目中包含的版本。

Short其他執行資訊(transaction/batch/history)
40. Bundle.entry.request.method
Definition

在 transaction 或 batch 中,這是此條目要執行的 HTTP 操作。在history Bundle中,這表示發生的 HTTP 操作。

BindingThe codes SHALL be taken from HTTPVerb
(required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)

應填入所綁定值集中的其中一個代碼。

42. Bundle.entry.request.url
Definition

此條目相對於根地址(請求發布的地址)的 URL。

Short此Bundle HTTP 對應的 URL
Comments

例如:對於 病人創建(Patient Create),方法是 「POST」,URL 是 「Patient」。對於病人更新(Patient Update),方法是 「PUT」,URL 是 「Patient/[id]」。

44. Bundle.entry.request.ifNoneMatch
Definition

如果 ETag 值匹配,則返回 304 未修改狀態(Not Modified)。請參閱「[有條件讀取(Conditional Read)](http://hl7.org/fhir/R4/http.html#cread)」的 API 文件。

Short用於管理緩存當前狀態
46. Bundle.entry.request.ifModifiedSince
Definition

僅在最後更新日期匹配時執行操作。請參閱 「[有條件讀取(Conditional Read)](http://hl7.org/fhir/R4/http.html#cread)」的 API 文件。

Short用於管理緩存當前狀態
48. Bundle.entry.request.ifMatch
Definition

只有在 Etag 值匹配時才執行操作。有關詳細資訊,請參閱 API 部分 「[管理resource衝突](http://hl7.org/fhir/R4/http.html#concurrency)」。

Short用於管理更新衝突
50. Bundle.entry.request.ifNoneExist
Definition

如果指定的resource已經存在,則指示伺服器不執行創建。有關詳細資訊,請參閱 「[有條件創建 (Conditional Creage)](http://hl7.org/fhir/R4/http.html#ccreate)」的 API 文件。這只是 URL 的查詢部分,即「? 」後面的內容(不包括「?」)。

Short用於有條件建立
52. Bundle.entry.response
Definition

表表示 batch 或 transaction 中相應「請求」條目的處理結果,或返回history時的操作結果。

Short執行結果(transaction/batch/history)
54. Bundle.entry.response.status
Definition

處理此條目時返回的狀態編碼。狀態 必須(SHALL) 以三位 HTTP 編碼(如 404)開頭,並可包含與狀態編碼相關的標準 HTTP 描述。

Short狀態回應代碼(文字選填)
56. Bundle.entry.response.location
Definition

處理該操作時創建的位置表頭(location header),如果該操作返回位置,則填入該位地置表頭。

Short位置(如果操作返回位置)
58. Bundle.entry.response.etag
Definition

resource的 Etag,如果條目的操作產生了版本化resource(請參閱 「[Resource Metadata及版本化和管理resource衝突」](http://hl7.org/fhir/R4/http.html#versioning))。

Shortresource的 Etag(如果有相關)
Comments

Etag 與 Resource.meta.versionId 匹配。如果包含resource,ETag 必須與表頭中的版本 ID 相匹配。

60. Bundle.entry.response.lastModified
Definition

此resource在伺服器上被修改的日期/時間。

Short修改時之伺服器日期時間
Comments

如果包含resource,則必須與meta.lastUpdated中的時間一致。

62. Bundle.entry.response.outcome
Definition

操作結果(OperationOutcome),包含在batch或transaction中處理此條目時產生的提示和警告。

Short帶提示和警告的OperationOutcome(用於batch/transaction)
Comments

對於 POST/PUT 操作,這是 prefer = operationoutcome 將返回的等價結果,但無論是否返回結果,resource都會被返回。此結果不用於批次處理/異動處理中的錯誤響應,僅用於提示和警告。在批次處理操作中,錯誤將出現在 Bundle.entry.response 中,而在異動處理中,如果出現錯誤,將只有一個 OperationOutcome 而不是一個 bundle。

64. Bundle.signature
Definition

數位簽章 - base64 編碼。XML-DSig 或 JWT。

Short數位簽章
Comments

簽章可以由bundle的「作者(author)」或是發起的設備所創建。關於是否要包含簽章、如何驗證簽章,以及如何處理已簽章與未簽章的bundle,這些要求會根據實作的環境而有所不同。

Requirements

簽章(Signature)以 FHIR 可存取的形式保存簽章及其支持上下文的電子表述。簽章可以是加密類型(XML DigSig 或 JWS),能夠提供不可否認性證明,也可以是表示簽章或簽章過程的圖形化圖像。該資料項目允許截取 document、message、transation甚至search回應上的簽章,以支持內容驗證、不可否認性或其他業務情況。這主要適用於Bundle可能透過多節點傳輸或其他機制傳輸的情況,因為 HTTPS 的不可否認性是不夠的。

Guidance on how to interpret the contents of this table can be found here

0. Bundle
Definition

用於存於一組Resources的結構或物件


A container for a collection of resources.

Short包含resourceBundleContains a collection of resources
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsbdl-1: total only when a search or history (total.empty() or (type = 'searchset') or (type = 'history'))
bdl-2: entry.search only when a search (entry.search.empty() or (type = 'searchset'))
bdl-3: 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: 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-7: 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-9: A document must have an identifier with a system and a value (type = 'document' implies (identifier.system.exists() and identifier.value.exists()))
bdl-10: A document must have a date (type = 'document' implies (timestamp.hasValue()))
bdl-11: A document must have a Composition as the first resource (type = 'document' implies entry.first().resource.is(Composition))
bdl-12: A message must have a MessageHeader as the first resource (type = 'message' implies entry.first().resource.is(MessageHeader))
bdl-1: total only when a search or history (total.empty() or (type = 'searchset') or (type = 'history'))
bdl-2: entry.search only when a search (entry.search.empty() or (type = 'searchset'))
bdl-3: 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: 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-7: 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-9: A document must have an identifier with a system and a value (type = 'document' implies (identifier.system.exists() and identifier.value.exists()))
bdl-10: A document must have a date (type = 'document' implies (timestamp.hasValue()))
bdl-11: A document must have a Composition as the first resource (type = 'document' implies entry.first().resource.is(Composition))
bdl-12: A message must have a MessageHeader as the first resource (type = 'message' implies entry.first().resource.is(MessageHeader))
2. Bundle.id
Definition

resource的邏輯ID,在resource的URL中使用。一旦指定,這個值永遠不會改變。


The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Short不重複的ID用以識別儲存在特定FHIR Server中的Bundle紀錄,通常又稱為邏輯性ID。Logical id of this artifact
Comments

一個resource使用新增操作(create operation)提交給伺服器時,此resource沒有id,它的id在resource被創建後由伺器分配/指定。


The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control0..1
Typeidstring
Is Modifierfalse
Summarytrue
4. Bundle.meta
Definition

關於resource的metadata。這是由基礎建設維護的內容。內容的更改可能並不總是與resource的版本更改相關聯。


The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Short此Bundle Resource的metadataMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Bundle.implicitRules
Definition

構建resource時遵循的一系列規則的參照,在處理內容時必須理解這些規則。通常這是對IG所定義之特殊規則及其他profiles的參照。


A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Short創建此內容所依據的一組規則A set of rules under which this content was created
Comments

宣告這套規則限制了內容只能被有限的交易夥伴所理解。這從本質上限制了資料的長期有用性。然而,現有的健康生態體系高度分裂,還沒有準備好以普遍可計算的方式定義、收集和交換資料。只要有可能,實作者和/或規範編寫者應該避免使用這個資料項目。通常在使用時,此URL是對IG的參照,此IG將這些特殊規則與其他profiles、value sets等一起定義為其敘述的一部分。


Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Bundle.language
Definition

編寫此resource的語言


The base language in which the resource is written.

Short用以表述Bundle Resource內容的語言。Language of the resource content
Comments

提供語言是為了支援索引和可存取性(通常,文字表述轉語音等服務使用此語言標籤)。html lanuage tag適用於此敘述。resource上的語言標籤可用於指定從resource中的資料所產成的其他表述之語言。不是所有的內容都必須使用此語言。不應該假定Resource.language自動適用於敘述。如果指定語言,它也應該被指定在html中的div資料項目(關於xml:lang和html lang屬性之間的關係,見HTML5中的規則)。


Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
BindingThe codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages
(preferred to http://hl7.org/fhir/ValueSet/languages)

人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。


A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Example<br/><b>Value</b>:zh-TW
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Bundle.identifier
Definition

Bundle的永久識別碼,識別碼不會因為Bundle從一個伺服器複製到另一個伺服器而改變。。


A persistent identifier for the bundle that won't change as a bundle is copied from server to server.

Short一組Resources的資料交換基本單位(Bundle)的識別碼。Persistent identifier for the bundle
Comments

永久的識別通常只對Document、Message和Collection的批次處理是重要。它通常不會被填入到searh和history的結果中,伺服器在處理batches和transactions時會忽略Bundle.identifier。但對於Documents的identifier 必須(SHALL) 被填入,其為全球唯一的識別碼。


Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Bundle.type
Definition

表明這個Bundle的目的-期望如何使用。


Indicates the purpose of this bundle - how it is intended to be used.

Shortdocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Comments

Bundle也可以用於其他目的(例如,document可以作為transaction被接受)。這主要是為了給某些Bundle類型制定特定的規則。


It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.

Control1..1
BindingThe codes SHALL be taken from BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/bundle-type|4.0.1)

Bundle類型;應填入所綁定值集中的其中一個代碼。


Indicates the purpose of a bundle - how it is intended to be used.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Bundle.timestamp
Definition

Bundle組裝的日期/時間 - 也就是resources被放入Bundle的時間。


The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.

Short組成Bundle的時間。When the bundle was assembled
Comments

對很多Bundle而言,時間戳記同等於.meta.lastUpdated,因為它們不會被儲存(例如:查詢結果)。當一個Bundl被放置在一個持久化存儲中(a persistent store)時,.meta.lastUpdated通常會被伺服器改變。當Bundle是一個Message時,中介軟體(即使沒有存儲)**建議應該(SHOULD)更新.meta.lastUpdated。.timestamp用於追踪Bundle的原始時間,並且建議應該(SHOULD)**被填入。

使用方法:

  • document : 文件的創建日期。注意:composition的創建可能早於Bundle的創鍵,或者composition會與多個文件相關聯。composition的編輯日期可能早於Bundle的組成時間。
  • mssage:訊息內容被組成的日期。這個日期不會被中介軟體引擎改變,除非他們增加了額外的資料,改變了訊息的時間含義。
  • history : 歷史紀錄被組成的日期。這個時間將被用於查詢_since(自此)時間後的後續更新紀錄。
  • searchset : 查詢結果集:是指查詢結果組合起來的時間。要注意的是,不同的頁面**可能(MAY)**會有不同的時間標記,但不是必須的。即使時間標記不同,也不代表隨後的頁面會顯示或包含從最初查詢後所做的變更。

transaction | transaction-response | batch | batch-response | collection : 沒有特別指定的含義。 時間戳記的值應該比Bundle中的resources的 lastUpdated 和其他時間戳記還要新,而且應該等於或早於Bundle本身的 .meta.lastUpdated 相同或更早。


For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.

Usage:

  • document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
  • message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
  • history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
  • searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
  • transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning

The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.

Control0..1
Typeinstant
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Bundle.total
Definition

如果有一組查詢結果相符,這個數字代表所有頁面中 type「match」條目的總數。這個總數不包括search.mode=「include」 或 「outcome」的查詢結果,也不表示Bundle內全部條目的數量。


If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.

Short查詢時符合條件的總筆數If search, the total number of matches
Comments

只在Bundle是查詢結果集時使用。這個總數不包括像是OperationOutcome和Bundle中包含的resources等,只計算匹配的resources的總數。


Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.

Control0..1
This element is affected by the following invariants: bdl-1
TypeunsignedInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Bundle.link
Definition

一系列連結,為這個Bundle提供上下文。


A series of links that provide context to this bundle.

Short與此Bundle相關的連結Links related to this Bundle
Comments

Bundle.link和Bundle.entry.link的設計是為了在使用Bundle時(例如實現HATEOAS時)提供更多的上下文資訊。

如果entry中的resource是直接被讀取的,那麼Bundle.entry.link就對應於HTTP header中的連結。

雖然這個規範對於查詢和分頁有一些Bundle.link的特定使用方式,但對於Bundle.entry.link沒有特定的使用方式,也沒有在transaction過程中定義其功能 - 它的具體意義取決於實際的應用方式。


Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. HATEOAS).

Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was read directly.

This specification defines some specific uses of Bundle.link for searching and paging, but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Bundle.link.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
22. Bundle.link.relation
Definition

詳細說明該連結功能用途的名稱 - 參見http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1


A name which details the functional use for this link - see http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1.

Short參見 [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)See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Bundle.link.url
Definition

連結的參照細節


The reference details for the link.

Short連結的參照細節Reference details for the link
Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Bundle.entry
Definition

Bundle resource中的條目 - 將包含一個resource或是關於resource的資訊(僅限transactions和history)。


An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

Short在bundle中的條目 - 將會有一個resource或資訊,這個重複的資料項目順序:對於type為「document」和「message」的bundles,第一個resource是特殊的(必須分別是Composition或MessageHeader)。對於所有bundles,條目順序的意義取決於bundle的type。Entry in the bundle - will have a resource or information
Control0..*
TypeBackboneElement
Is Modifierfalse
Summarytrue
Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
28. Bundle.entry.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
30. Bundle.entry.link
Definition

為本條目提供情境背景的一系列連結。


A series of links that provide context to this entry.

Short與本條目相關的連結Links related to this entry
Control0..*
TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Bundle.entry.fullUrl
Definition

resource的絕對URL。fullUrl **必須沒有(SHALL NOT)**與resource中的 id 不一致,也就是說如果 fullUrl 不是 urn:uuid,則 URL 應為與 Resource.id 一致的不分版本的URL。fullUrl 是對resource的不分版本參照。fullUrl 資料項目必須有一個值,但以下情況除外:

在 POST 時,fullUrl 可以為空(雖然在 bundle 中包含暫時 id 時,fullUrl 不需要為空) 操作結果可能涉及未被識別的resources。


The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
ShortResource的 URI(絕對 URL 伺服器地址或 UUID/OID 的 URI)URI for resource (Absolute URL server address or URI for UUID/OID)
Comments

fullUrl 在resource上下文中可能不是唯一的。請注意:由於 FHIR resource不需要透過 FHIR API 提供服務,因此 fullURL 可能是一個 URN 或絕對 URL,而不是以resource的邏輯 id(Resource.id)結尾。但是,如果 fullUrl 看起來確實像 RESTful 伺服器 URL(例如:符合正則表達式regex,則 fullUrl 的 「id」部分 必須(SHALL) 以 Resource.id 結尾。

請注意:fullUrl 與 canonical URL(正準URL) 並不相同,fullUrl是為resource提供服務的端點的絕對 URL(這些在為 resource 帶有 canonical URL 的 Canonical 伺服器上將具有相同的值)。


fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Bundle.entry.resource
Definition

Bundle中的resource。resource的目的/含義由 Bundle.type 決定。


The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

ShortBundle中的resourceA resource in the bundle
Control0..1
TypeResource
Is Modifierfalse
Summarytrue
36. Bundle.entry.search
Definition

有關如何進行查詢才能創建此條目的解釋資訊。


Information about the search process that lead to the creation of this entry.

Short查詢有關的資訊Search related information
Control0..1
This element is affected by the following invariants: bdl-2
TypeBackboneElement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Bundle.entry.search.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
40. Bundle.entry.search.mode
Definition

此條目出現在結果集中的原因--是因為符合match要求還是因為 _include 要求,或者是為了傳達有關查詢過程的資訊或警告資訊。


Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

Shortmatch | include | outcomematch | include | outcome - why this is in the result set
Comments

只有一種模式。在某些情況下,一個resource可能會被包含,因為它既是match也是include的resource。在這種情況下,「match」優先。


There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.

Control0..1
BindingThe codes SHALL be taken from SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
(required to http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1)

Resource出現在Bundle中的原因;應填入所綁定值集中的其中一個代碼。


Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Bundle.entry.search.score
Definition

查詢時,該條目在伺服器上的查詢排名得分。


When searching, the server's search ranking score for the entry.

Short查詢排名(0至1之間)Search ranking (between 0 and 1)
Comments

伺服器無需返回排名得分,1 表示最相關,0 表示最不相關。通常情況下,查詢結果按得分排序,但用戶可指定不同的排序順序。

請參閱「病人匹配(Patient Match)」以了解與此資料項目相關的 EMPI 查詢。請參閱[Patient Match](http://hl7.org/fhir/R4/patient-operation-match.html),了解與此要素相關的 EMPI 查詢。


Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.

See Patient Match for the EMPI search which relates to this element.

Control0..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. Bundle.entry.request
Definition

關於如何將條目作為transaction或batch的一部分進行處理的附加資訊。對於history,它顯示如何處理條目以創建條目中包含的版本。


Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Short其他執行資訊(transaction/batch/history)Additional execution information (transaction/batch/history)
Control0..1
This element is affected by the following invariants: bdl-3
TypeBackboneElement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Bundle.entry.request.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
48. Bundle.entry.request.method
Definition

在 transaction 或 batch 中,這是此條目要執行的 HTTP 操作。在history Bundle中,這表示發生的 HTTP 操作。


In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.

ShortGET | HEAD | POST | PUT | DELETE | PATCH
Control1..1
BindingThe codes SHALL be taken from HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1
(required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)

應填入所綁定值集中的其中一個代碼。


HTTP verbs (in the HTTP command line). See HTTP rfc for details.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Bundle.entry.request.url
Definition

此條目相對於根地址(請求發布的地址)的 URL。


The URL for this entry, relative to the root (the address to which the request is posted).

Short此Bundle HTTP 對應的 URLURL for HTTP equivalent of this entry
Comments

例如:對於 病人創建(Patient Create),方法是 「POST」,URL 是 「Patient」。對於病人更新(Patient Update),方法是 「PUT」,URL 是 「Patient/[id]」。


E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".

Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. Bundle.entry.request.ifNoneMatch
Definition

如果 ETag 值匹配,則返回 304 未修改狀態(Not Modified)。請參閱「[有條件讀取(Conditional Read)](http://hl7.org/fhir/R4/http.html#cread)」的 API 文件。


If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".

Short用於管理緩存當前狀態For managing cache currency
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Bundle.entry.request.ifModifiedSince
Definition

僅在最後更新日期匹配時執行操作。請參閱 「[有條件讀取(Conditional Read)](http://hl7.org/fhir/R4/http.html#cread)」的 API 文件。


Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".

Short用於管理緩存當前狀態For managing cache currency
Control0..1
Typeinstant
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. Bundle.entry.request.ifMatch
Definition

只有在 Etag 值匹配時才執行操作。有關詳細資訊,請參閱 API 部分 「[管理resource衝突](http://hl7.org/fhir/R4/http.html#concurrency)」。


Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention".

Short用於管理更新衝突For managing update contention
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Bundle.entry.request.ifNoneExist
Definition

如果指定的resource已經存在,則指示伺服器不執行創建。有關詳細資訊,請參閱 「[有條件創建 (Conditional Creage)](http://hl7.org/fhir/R4/http.html#ccreate)」的 API 文件。這只是 URL 的查詢部分,即「? 」後面的內容(不包括「?」)。


Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?").

Short用於有條件建立For conditional creates
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. Bundle.entry.response
Definition

表表示 batch 或 transaction 中相應「請求」條目的處理結果,或返回history時的操作結果。


Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Short執行結果(transaction/batch/history)Results of execution (transaction/batch/history)
Control0..1
This element is affected by the following invariants: bdl-4
TypeBackboneElement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. Bundle.entry.response.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
64. Bundle.entry.response.status
Definition

處理此條目時返回的狀態編碼。狀態 必須(SHALL) 以三位 HTTP 編碼(如 404)開頭,並可包含與狀態編碼相關的標準 HTTP 描述。


The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.

Short狀態回應代碼(文字選填)Status response code (text optional)
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. Bundle.entry.response.location
Definition

處理該操作時創建的位置表頭(location header),如果該操作返回位置,則填入該位地置表頭。


The location header created by processing this operation, populated if the operation returns a location.

Short位置(如果操作返回位置)The location (if the operation returns a location)
Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. Bundle.entry.response.etag
Definition

resource的 Etag,如果條目的操作產生了版本化resource(請參閱 「[Resource Metadata及版本化和管理resource衝突」](http://hl7.org/fhir/R4/http.html#versioning))。


The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention).

Shortresource的 Etag(如果有相關)The Etag for the resource (if relevant)
Comments

Etag 與 Resource.meta.versionId 匹配。如果包含resource,ETag 必須與表頭中的版本 ID 相匹配。


Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. Bundle.entry.response.lastModified
Definition

此resource在伺服器上被修改的日期/時間。


The date/time that the resource was modified on the server.

Short修改時之伺服器日期時間Server's date time modified
Comments

如果包含resource,則必須與meta.lastUpdated中的時間一致。


This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.

Control0..1
Typeinstant
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. Bundle.entry.response.outcome
Definition

操作結果(OperationOutcome),包含在batch或transaction中處理此條目時產生的提示和警告。


An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

Short帶提示和警告的OperationOutcome(用於batch/transaction)OperationOutcome with hints and warnings (for batch/transaction)
Comments

對於 POST/PUT 操作,這是 prefer = operationoutcome 將返回的等價結果,但無論是否返回結果,resource都會被返回。此結果不用於批次處理/異動處理中的錯誤響應,僅用於提示和警告。在批次處理操作中,錯誤將出現在 Bundle.entry.response 中,而在異動處理中,如果出現錯誤,將只有一個 OperationOutcome 而不是一個 bundle。


For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.

This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.

Control0..1
TypeResource
Is Modifierfalse
Summarytrue
74. Bundle.signature
Definition

數位簽章 - base64 編碼。XML-DSig 或 JWT。


Digital Signature - base64 encoded. XML-DSig or a JWT.

Short數位簽章Digital Signature
Comments

簽章可以由bundle的「作者(author)」或是發起的設備所創建。關於是否要包含簽章、如何驗證簽章,以及如何處理已簽章與未簽章的bundle,這些要求會根據實作的環境而有所不同。


The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.

Control0..1
TypeSignature
Is Modifierfalse
Summarytrue
Requirements

簽章(Signature)以 FHIR 可存取的形式保存簽章及其支持上下文的電子表述。簽章可以是加密類型(XML DigSig 或 JWS),能夠提供不可否認性證明,也可以是表示簽章或簽章過程的圖形化圖像。該資料項目允許截取 document、message、transation甚至search回應上的簽章,以支持內容驗證、不可否認性或其他業務情況。這主要適用於Bundle可能透過多節點傳輸或其他機制傳輸的情況,因為 HTTPS 的不可否認性是不夠的。


A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. Bundle
Definition

用於存於一組Resources的結構或物件

Short包含resourceBundle
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsbdl-1: total only when a search or history (total.empty() or (type = 'searchset') or (type = 'history'))
bdl-2: entry.search only when a search (entry.search.empty() or (type = 'searchset'))
bdl-3: 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: 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-7: 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-9: A document must have an identifier with a system and a value (type = 'document' implies (identifier.system.exists() and identifier.value.exists()))
bdl-10: A document must have a date (type = 'document' implies (timestamp.hasValue()))
bdl-11: A document must have a Composition as the first resource (type = 'document' implies entry.first().resource.is(Composition))
bdl-12: A message must have a MessageHeader as the first resource (type = 'message' implies entry.first().resource.is(MessageHeader))
2. Bundle.id
Definition

resource的邏輯ID,在resource的URL中使用。一旦指定,這個值永遠不會改變。

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

一個resource使用新增操作(create operation)提交給伺服器時,此resource沒有id,它的id在resource被創建後由伺器分配/指定。

Control0..1
Typeid
Is Modifierfalse
Summarytrue
4. Bundle.meta
Definition

關於resource的metadata。這是由基礎建設維護的內容。內容的更改可能並不總是與resource的版本更改相關聯。

Short此Bundle Resource的metadata
Control0..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Bundle.implicitRules
Definition

構建resource時遵循的一系列規則的參照,在處理內容時必須理解這些規則。通常這是對IG所定義之特殊規則及其他profiles的參照。

Short創建此內容所依據的一組規則
Comments

宣告這套規則限制了內容只能被有限的交易夥伴所理解。這從本質上限制了資料的長期有用性。然而,現有的健康生態體系高度分裂,還沒有準備好以普遍可計算的方式定義、收集和交換資料。只要有可能,實作者和/或規範編寫者應該避免使用這個資料項目。通常在使用時,此URL是對IG的參照,此IG將這些特殊規則與其他profiles、value sets等一起定義為其敘述的一部分。

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Bundle.language
Definition

編寫此resource的語言

Short用以表述Bundle Resource內容的語言。
Comments

提供語言是為了支援索引和可存取性(通常,文字表述轉語音等服務使用此語言標籤)。html lanuage tag適用於此敘述。resource上的語言標籤可用於指定從resource中的資料所產成的其他表述之語言。不是所有的內容都必須使用此語言。不應該假定Resource.language自動適用於敘述。如果指定語言,它也應該被指定在html中的div資料項目(關於xml:lang和html lang屬性之間的關係,見HTML5中的規則)。

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages)

人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Example<br/><b>Value</b>:zh-TW
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Bundle.identifier
Definition

Bundle的永久識別碼,識別碼不會因為Bundle從一個伺服器複製到另一個伺服器而改變。。

Short一組Resources的資料交換基本單位(Bundle)的識別碼。
Comments

永久的識別通常只對Document、Message和Collection的批次處理是重要。它通常不會被填入到searh和history的結果中,伺服器在處理batches和transactions時會忽略Bundle.identifier。但對於Documents的identifier 必須(SHALL) 被填入,其為全球唯一的識別碼。

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Bundle.type
Definition

表明這個Bundle的目的-期望如何使用。

Shortdocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Comments

Bundle也可以用於其他目的(例如,document可以作為transaction被接受)。這主要是為了給某些Bundle類型制定特定的規則。

Control1..1
BindingThe codes SHALL be taken from BundleType
(required to http://hl7.org/fhir/ValueSet/bundle-type|4.0.1)

Bundle類型;應填入所綁定值集中的其中一個代碼。

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Bundle.timestamp
Definition

Bundle組裝的日期/時間 - 也就是resources被放入Bundle的時間。

Short組成Bundle的時間。
Comments

對很多Bundle而言,時間戳記同等於.meta.lastUpdated,因為它們不會被儲存(例如:查詢結果)。當一個Bundl被放置在一個持久化存儲中(a persistent store)時,.meta.lastUpdated通常會被伺服器改變。當Bundle是一個Message時,中介軟體(即使沒有存儲)**建議應該(SHOULD)更新.meta.lastUpdated。.timestamp用於追踪Bundle的原始時間,並且建議應該(SHOULD)**被填入。

使用方法:

  • document : 文件的創建日期。注意:composition的創建可能早於Bundle的創鍵,或者composition會與多個文件相關聯。composition的編輯日期可能早於Bundle的組成時間。
  • mssage:訊息內容被組成的日期。這個日期不會被中介軟體引擎改變,除非他們增加了額外的資料,改變了訊息的時間含義。
  • history : 歷史紀錄被組成的日期。這個時間將被用於查詢_since(自此)時間後的後續更新紀錄。
  • searchset : 查詢結果集:是指查詢結果組合起來的時間。要注意的是,不同的頁面**可能(MAY)**會有不同的時間標記,但不是必須的。即使時間標記不同,也不代表隨後的頁面會顯示或包含從最初查詢後所做的變更。

transaction | transaction-response | batch | batch-response | collection : 沒有特別指定的含義。 時間戳記的值應該比Bundle中的resources的 lastUpdated 和其他時間戳記還要新,而且應該等於或早於Bundle本身的 .meta.lastUpdated 相同或更早。

Control0..1
Typeinstant
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Bundle.total
Definition

如果有一組查詢結果相符,這個數字代表所有頁面中 type「match」條目的總數。這個總數不包括search.mode=「include」 或 「outcome」的查詢結果,也不表示Bundle內全部條目的數量。

Short查詢時符合條件的總筆數
Comments

只在Bundle是查詢結果集時使用。這個總數不包括像是OperationOutcome和Bundle中包含的resources等,只計算匹配的resources的總數。

Control0..1
This element is affected by the following invariants: bdl-1
TypeunsignedInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Bundle.link
Definition

一系列連結,為這個Bundle提供上下文。

Short與此Bundle相關的連結
Comments

Bundle.link和Bundle.entry.link的設計是為了在使用Bundle時(例如實現HATEOAS時)提供更多的上下文資訊。

如果entry中的resource是直接被讀取的,那麼Bundle.entry.link就對應於HTTP header中的連結。

雖然這個規範對於查詢和分頁有一些Bundle.link的特定使用方式,但對於Bundle.entry.link沒有特定的使用方式,也沒有在transaction過程中定義其功能 - 它的具體意義取決於實際的應用方式。

Control0..*
TypeBackboneElement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Bundle.link.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
22. Bundle.link.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
24. Bundle.link.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
26. Bundle.link.relation
Definition

詳細說明該連結功能用途的名稱 - 參見http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1

Short參見 [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)
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Bundle.link.url
Definition

連結的參照細節

Short連結的參照細節
Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Bundle.entry
Definition

Bundle resource中的條目 - 將包含一個resource或是關於resource的資訊(僅限transactions和history)。

Short在bundle中的條目 - 將會有一個resource或資訊,這個重複的資料項目順序:對於type為「document」和「message」的bundles,第一個resource是特殊的(必須分別是Composition或MessageHeader)。對於所有bundles,條目順序的意義取決於bundle的type。
Control0..*
TypeBackboneElement
Is Modifierfalse
Summarytrue
Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Bundle.entry.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
34. Bundle.entry.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
36. Bundle.entry.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
38. Bundle.entry.link
Definition

為本條目提供情境背景的一系列連結。

Short與本條目相關的連結
Control0..*
TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Bundle.entry.fullUrl
Definition

resource的絕對URL。fullUrl **必須沒有(SHALL NOT)**與resource中的 id 不一致,也就是說如果 fullUrl 不是 urn:uuid,則 URL 應為與 Resource.id 一致的不分版本的URL。fullUrl 是對resource的不分版本參照。fullUrl 資料項目必須有一個值,但以下情況除外:

在 POST 時,fullUrl 可以為空(雖然在 bundle 中包含暫時 id 時,fullUrl 不需要為空) 操作結果可能涉及未被識別的resources。

ShortResource的 URI(絕對 URL 伺服器地址或 UUID/OID 的 URI)
Comments

fullUrl 在resource上下文中可能不是唯一的。請注意:由於 FHIR resource不需要透過 FHIR API 提供服務,因此 fullURL 可能是一個 URN 或絕對 URL,而不是以resource的邏輯 id(Resource.id)結尾。但是,如果 fullUrl 看起來確實像 RESTful 伺服器 URL(例如:符合正則表達式regex,則 fullUrl 的 「id」部分 必須(SHALL) 以 Resource.id 結尾。

請注意:fullUrl 與 canonical URL(正準URL) 並不相同,fullUrl是為resource提供服務的端點的絕對 URL(這些在為 resource 帶有 canonical URL 的 Canonical 伺服器上將具有相同的值)。

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Bundle.entry.resource
Definition

Bundle中的resource。resource的目的/含義由 Bundle.type 決定。

ShortBundle中的resource
Control0..1
TypeResource
Is Modifierfalse
Summarytrue
44. Bundle.entry.search
Definition

有關如何進行查詢才能創建此條目的解釋資訊。

Short查詢有關的資訊
Control0..1
This element is affected by the following invariants: bdl-2
TypeBackboneElement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Bundle.entry.search.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
48. Bundle.entry.search.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
50. Bundle.entry.search.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
52. Bundle.entry.search.mode
Definition

此條目出現在結果集中的原因--是因為符合match要求還是因為 _include 要求,或者是為了傳達有關查詢過程的資訊或警告資訊。

Shortmatch | include | outcome
Comments

只有一種模式。在某些情況下,一個resource可能會被包含,因為它既是match也是include的resource。在這種情況下,「match」優先。

Control0..1
BindingThe codes SHALL be taken from SearchEntryMode
(required to http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1)

Resource出現在Bundle中的原因;應填入所綁定值集中的其中一個代碼。

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Bundle.entry.search.score
Definition

查詢時,該條目在伺服器上的查詢排名得分。

Short查詢排名(0至1之間)
Comments

伺服器無需返回排名得分,1 表示最相關,0 表示最不相關。通常情況下,查詢結果按得分排序,但用戶可指定不同的排序順序。

請參閱「病人匹配(Patient Match)」以了解與此資料項目相關的 EMPI 查詢。請參閱[Patient Match](http://hl7.org/fhir/R4/patient-operation-match.html),了解與此要素相關的 EMPI 查詢。

Control0..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. Bundle.entry.request
Definition

關於如何將條目作為transaction或batch的一部分進行處理的附加資訊。對於history,它顯示如何處理條目以創建條目中包含的版本。

Short其他執行資訊(transaction/batch/history)
Control0..1
This element is affected by the following invariants: bdl-3
TypeBackboneElement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Bundle.entry.request.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
60. Bundle.entry.request.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
62. Bundle.entry.request.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
64. Bundle.entry.request.method
Definition

在 transaction 或 batch 中,這是此條目要執行的 HTTP 操作。在history Bundle中,這表示發生的 HTTP 操作。

ShortGET | HEAD | POST | PUT | DELETE | PATCH
Control1..1
BindingThe codes SHALL be taken from HTTPVerb
(required to http://hl7.org/fhir/ValueSet/http-verb|4.0.1)

應填入所綁定值集中的其中一個代碼。

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. Bundle.entry.request.url
Definition

此條目相對於根地址(請求發布的地址)的 URL。

Short此Bundle HTTP 對應的 URL
Comments

例如:對於 病人創建(Patient Create),方法是 「POST」,URL 是 「Patient」。對於病人更新(Patient Update),方法是 「PUT」,URL 是 「Patient/[id]」。

Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. Bundle.entry.request.ifNoneMatch
Definition

如果 ETag 值匹配,則返回 304 未修改狀態(Not Modified)。請參閱「[有條件讀取(Conditional Read)](http://hl7.org/fhir/R4/http.html#cread)」的 API 文件。

Short用於管理緩存當前狀態
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. Bundle.entry.request.ifModifiedSince
Definition

僅在最後更新日期匹配時執行操作。請參閱 「[有條件讀取(Conditional Read)](http://hl7.org/fhir/R4/http.html#cread)」的 API 文件。

Short用於管理緩存當前狀態
Control0..1
Typeinstant
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. Bundle.entry.request.ifMatch
Definition

只有在 Etag 值匹配時才執行操作。有關詳細資訊,請參閱 API 部分 「[管理resource衝突](http://hl7.org/fhir/R4/http.html#concurrency)」。

Short用於管理更新衝突
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. Bundle.entry.request.ifNoneExist
Definition

如果指定的resource已經存在,則指示伺服器不執行創建。有關詳細資訊,請參閱 「[有條件創建 (Conditional Creage)](http://hl7.org/fhir/R4/http.html#ccreate)」的 API 文件。這只是 URL 的查詢部分,即「? 」後面的內容(不包括「?」)。

Short用於有條件建立
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. Bundle.entry.response
Definition

表表示 batch 或 transaction 中相應「請求」條目的處理結果,或返回history時的操作結果。

Short執行結果(transaction/batch/history)
Control0..1
This element is affected by the following invariants: bdl-4
TypeBackboneElement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. Bundle.entry.response.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
80. Bundle.entry.response.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
82. Bundle.entry.response.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
84. Bundle.entry.response.status
Definition

處理此條目時返回的狀態編碼。狀態 必須(SHALL) 以三位 HTTP 編碼(如 404)開頭,並可包含與狀態編碼相關的標準 HTTP 描述。

Short狀態回應代碼(文字選填)
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. Bundle.entry.response.location
Definition

處理該操作時創建的位置表頭(location header),如果該操作返回位置,則填入該位地置表頭。

Short位置(如果操作返回位置)
Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. Bundle.entry.response.etag
Definition

resource的 Etag,如果條目的操作產生了版本化resource(請參閱 「[Resource Metadata及版本化和管理resource衝突」](http://hl7.org/fhir/R4/http.html#versioning))。

Shortresource的 Etag(如果有相關)
Comments

Etag 與 Resource.meta.versionId 匹配。如果包含resource,ETag 必須與表頭中的版本 ID 相匹配。

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. Bundle.entry.response.lastModified
Definition

此resource在伺服器上被修改的日期/時間。

Short修改時之伺服器日期時間
Comments

如果包含resource,則必須與meta.lastUpdated中的時間一致。

Control0..1
Typeinstant
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. Bundle.entry.response.outcome
Definition

操作結果(OperationOutcome),包含在batch或transaction中處理此條目時產生的提示和警告。

Short帶提示和警告的OperationOutcome(用於batch/transaction)
Comments

對於 POST/PUT 操作,這是 prefer = operationoutcome 將返回的等價結果,但無論是否返回結果,resource都會被返回。此結果不用於批次處理/異動處理中的錯誤響應,僅用於提示和警告。在批次處理操作中,錯誤將出現在 Bundle.entry.response 中,而在異動處理中,如果出現錯誤,將只有一個 OperationOutcome 而不是一個 bundle。

Control0..1
TypeResource
Is Modifierfalse
Summarytrue
94. Bundle.signature
Definition

數位簽章 - base64 編碼。XML-DSig 或 JWT。

Short數位簽章
Comments

簽章可以由bundle的「作者(author)」或是發起的設備所創建。關於是否要包含簽章、如何驗證簽章,以及如何處理已簽章與未簽章的bundle,這些要求會根據實作的環境而有所不同。

Control0..1
TypeSignature
Is Modifierfalse
Summarytrue
Requirements

簽章(Signature)以 FHIR 可存取的形式保存簽章及其支持上下文的電子表述。簽章可以是加密類型(XML DigSig 或 JWS),能夠提供不可否認性證明,也可以是表示簽章或簽章過程的圖形化圖像。該資料項目允許截取 document、message、transation甚至search回應上的簽章,以支持內容驗證、不可否認性或其他業務情況。這主要適用於Bundle可能透過多節點傳輸或其他機制傳輸的情況,因為 HTTPS 的不可否認性是不夠的。

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))