電子カルテ情報共有サービス2文書5情報+患者サマリー FHIR実装ガイド JP-CLINS(CLinical Information Sharing ImplementationGuide) v1.5.5
1.5.5 - release Japan

Resource Profile: JP_Bundle

項目内容
定義URL http://jpfhir.jp/fhir/StructureDefinition/JP_Bundle
Version 1.5.5
Name

JP_Bundle

Status Active ( 2024-02-07 )
Copyright

(一社)日本医療情報学会. CC BY-ND 4.0

Derived Profile from JP-Core


Usage:

プロファイル詳細

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle Bundle
... meta
.... lastUpdated S 0..1 instant リソースのバージョンが最後に変更されたとき

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle リソースのコレクションが含まれています / Contains a collection of resources
bdl-1: totalは、searchまたはhistoryの場合にのみ出現します / total only when a search or history
bdl-2: Entry.Searchはsearchの場合にのみ出現します。 / entry.search only when a search
bdl-3: Entry.Requestはbatch/transaction/historyで必須、それ以外の場合は禁止されています / entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.responseは、batch-response/transaction-response/historyに必須であり、それ以外の場合は禁止されています / entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-7: fullurlはBundleでユニークである必要があります。または、同じfullurlを持つentryはmeta.versionIdを持っている必要があります。 / 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: documentには、systemとvalueのある identifierが必要です / A document must have an identifier with a system and a value
bdl-10: documentにはdateが必要です / A document must have a date
bdl-11: documentには最初のリソースとしてCompositionが必要です / A document must have a Composition as the first resource
bdl-12: メッセージには最初のリソースとしてMessageHeaderが必要です / A message must have a MessageHeader as the first resource
... id Σ 0..1 id このアーティファクトの論理ID / Logical id of this artifact
... meta Σ 0..1 Meta リソースに関するMetadata / Metadata about the resource
.... id 0..1 string エレメント相互参照のためのユニークID
.... extension 0..* Extension 実装によって定義される追加コンテンツ
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id バージョン固有のidentifier (Baajon koyū no shikibetsu-shi)
.... lastUpdated SΣ 0..1 instant リソースのバージョンが最後に変更されたとき
.... source Σ 0..1 uri 「リソースがどこから来たかを特定する」
.... profile Σ 0..* canonical(StructureDefinition) このリソースが適合を主張するプロファイル
.... security Σ 0..* Coding このリソースに適用されたセキュリティラベル
Binding: All Security Labels (extensible): 医療プライバシーおよびセキュリティ分類システムからのセキュリティラベル。


.... tag Σ 0..* Coding このリソースに適用されたタグ
Binding: CommonTags (example): 様々なタグを表すコードで、一般的にはワークフローに関連しています。例:「ジョーンズ博士によるレビューが必要です」。


... implicitRules ?!Σ 0..1 uri このコンテンツが作成されたルールのセット / A set of rules under which this content was created
... language 0..1 code リソースコンテンツの言語 / Language of the resource content
Binding: CommonLanguages (preferred): 人間の言語。 / A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... identifier Σ 0..1 Identifier Bundleの永続的なidentifier / Persistent identifier for the bundle
... type Σ 1..1 code ドキュメント|メッセージ|トランザクション|トランザクション応答|バッチ|バッチ応答|歴史|検索セット|コレクション / document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Bundleの目的を示します - それがどのように使用されるか。 / Indicates the purpose of a bundle - how it is intended to be used.

... timestamp Σ 0..1 instant Bundleが組み立てられたとき / When the bundle was assembled
... total ΣC 0..1 unsignedInt 検索の場合、一致の総数 / If search, the total number of matches
... link Σ 0..* BackboneElement このBundleに関連するリンク / Links related to this Bundle
.... id 0..1 string 要素間参照のための一意のID / 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を参照してください / See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ 1..1 uri リンクの参照詳細 / Reference details for the link
... entry ΣC 0..* BackboneElement Bundleへのエントリ - リソースまたは情報があります / Entry in the bundle - will have a resource or information
bdl-5: リクエストまたは応答がない限り、リソースである必要があります / must be a resource unless there's a request or response
bdl-8: Fullurlはバージョン固有のリファレンスにすることはできません / fullUrl cannot be a version specific reference
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... id 0..1 string 要素間参照のための一意のID / 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) このエントリに関連するリンク / Links related to this entry
.... fullUrl Σ 0..1 uri リソース用のURI(絶対URLサーバーアドレスまたはUUID/OID用のURI) / URI for resource (Absolute URL server address or URI for UUID/OID)
.... resource Σ 0..1 Resource Bundleのリソース / A resource in the bundle
.... search ΣC 0..1 BackboneElement 関連情報を検索します / Search related information
..... id 0..1 string 要素間参照のための一意のID / 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 - why this is in the result set
Binding: SearchEntryMode (required): エントリが結果セットにある理由 - それが一致として含まれているか、_include要件が含まれているか、または検索プロセスに関する情報または警告情報を伝えるため。 / 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.

..... score Σ 0..1 decimal ランキングを検索(0〜1) / Search ranking (between 0 and 1)
.... request ΣC 0..1 BackboneElement 追加の実行情報(トランザクション/バッチ/履歴) / Additional execution information (transaction/batch/history)
..... id 0..1 string 要素間参照のための一意のID / 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 |頭|投稿|put |削除|パッチ / GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP動詞(HTTPコマンドライン)。詳細については、[http rfc](https://tools.ietf.org/html/rfc7231)を参照してください。 / HTTP verbs (in the HTTP command line). See HTTP rfc for details.

..... url Σ 1..1 uri このエントリに相当するHTTPのURL / URL for HTTP equivalent of this entry
..... ifNoneMatch Σ 0..1 string キャッシュ通貨を管理するため / For managing cache currency
..... ifModifiedSince Σ 0..1 instant キャッシュ通貨を管理するため / For managing cache currency
..... ifMatch Σ 0..1 string 更新競合を管理するため / For managing update contention
..... ifNoneExist Σ 0..1 string 条件付き作成の場合 / For conditional creates
.... response ΣC 0..1 BackboneElement 実行結果(トランザクション/バッチ/履歴) / Results of execution (transaction/batch/history)
..... id 0..1 string 要素間参照のための一意のID / 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 ステータス応答コード(テキストオプション) / Status response code (text optional)
..... location Σ 0..1 uri 場所(操作が場所を返す場合) / The location (if the operation returns a location)
..... etag Σ 0..1 string リソースのETAG(関連する場合) / The Etag for the resource (if relevant)
..... lastModified Σ 0..1 instant サーバーの日付時間が変更されました / Server's date time modified
..... outcome Σ 0..1 Resource ヒントと警告を備えたOperationOutcome(バッチ/トランザクション用) / OperationOutcome with hints and warnings (for batch/transaction)
... signature Σ 0..1 Signature デジタル署名 / Digital Signature

doco Documentation for this format

Terminology バインディング

PathConformanceValueSetURI
Bundle.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Bundle.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Bundle.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Bundle.typerequiredBundleType
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotalは、searchまたはhistoryの場合にのみ出現します / total only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleEntry.Searchはsearchの場合にのみ出現します。 / entry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleEntry.Requestはbatch/transaction/historyで必須、それ以外の場合は禁止されています / 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-4errorBundle entry.responseは、batch-response/transaction-response/historyに必須であり、それ以外の場合は禁止されています / 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-5errorBundle.entryリクエストまたは応答がない限り、リソースである必要があります / must be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundlefullurlはBundleでユニークである必要があります。または、同じfullurlを持つentryはmeta.versionIdを持っている必要があります。 / 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-8errorBundle.entryFullurlはバージョン固有のリファレンスにすることはできません / fullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundledocumentには、systemとvalueのある identifierが必要です / A document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundledocumentにはdateが必要です / A document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundledocumentには最初のリソースとしてCompositionが必要です / A document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleメッセージには最初のリソースとしてMessageHeaderが必要です / A message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsすべてのFHIR要素には、@valueまたは子要素が必要です / All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensions拡張機能または値[x]のいずれかが必要です。両方ではありません。
: extension.exists() != value.exists()