電子カルテ情報共有サービス2文書5情報+患者サマリー FHIR実装ガイド JP-CLINS(CLinical Information Sharing ImplementationGuide) 開発者向け参考情報 v1.10.0-20250208dev
1.10.0-20250208dev - update
Japan
項目 | 内容 |
定義URL | http://jpfhir.jp/fhir/clins/StructureDefinition/JP_Bundle_CLINS |
Version | 1.10.0-20250208dev |
Name | JP_Bundle_CLINS |
Title | CLINS電子カルテ情報共有サービス用:JP_Bundle_CLINS |
Status | Active ( 2025-01-11 ) |
Copyright | (一社)日本医療情報学会. CC BY-ND 4.0 |
CLINS 電子カルテ情報共有サービスへの5情報送信用 Bundleリソース プロファイル
このプロファイルは、5情報を送信するためにデータをまとめる役割をするBundleリソースのプロファイルを記述するためのものである。
CLINSに医療機関から送信する場合には、ひとつのBundleリソースタイプのリソースデータを作成し、同一リソースタイプの複数のリソース・インスタンスをまとめて1回の送信で送信する。CLINSで処理対象となっていないリソースタイプのデータが含まれている場合には、受信側では処理されず破棄される(エラーとはならない)。なお、ひとつのBundleリソースタイプのファイルのサイズ上限は「電子カルテ情報共有サービスの導入に関するシステムベンダ向け技術解説書」に記述があり、上限を超えるサイズになる場合には、分割した複数のBundleリソースファイルで送信する必要があることがある。
Bundleリソースの使い方については、本ページ後段にある、
を参照すること。
5情報を送信するためにデータをまとめる際に必ず使用するBundleリソースとなる。
- 必須要素、条件により必須要素、推奨要素は、自動的にMustSupport要素である。それ以外に以下の要素がMustSupport要素である。
多重度は、親要素が出現した場合の多重度。たとえばある子要素の多重度が1..1であっても親要素が出現しない場合にはその子要素は出現しない。逆に親要素が出現する場合には、この子要素は出現しなければならない。 | ||||||||
要素Lv1 | 要素Lv2 | 要素Lv3 | 要素Lv4 | 多重度 | 型 | 説明 | 固定値 / 例 示 |
固定値 または例示 |
resourceType | 1..1 | string | Bundleリソースであることを示す。 | 固定値 | "Bundle" | |||
meta | 1..1 | Meta | ||||||
meta | lastUpdated | 1..1 | instant | 最終更新日時。YYYY-MM-DDThh:mm:ss.sss+zz:zz この要素は、このリソースのデータを取り込んで蓄積していたシステムが、このリソースになんらかの変更があった可能性があった日時を取得し、このデータを再取り込みする必要性の判断をするために使われる。本要素に前回取り込んだ時点より後の日時が設定されている場合には、なんらかの変更があった可能性がある(変更がない場合もある)ものとして判断される。したがって、内容になんらかの変更があった場合、またはこのリソースのデータが初めて作成された場合には、その時点以降の日時(たとえば、このリソースのデータを作成した日時)を設定しなければならない。内容の変更がない場合でも、このリソースのデータが作り直された場合や単に複写された場合にその日時を設定しなおしてもよい。ただし、内容に変更がないのであれば、日時を変更しなくてもよい。また、この要素の変更とmeta.versionIdの変更とは、必ずしも連動しないことがある。 |
例示 | "2015-02-07T13:28:17.239+09:00" | ||
meta | profile[+] | 1..* | canonical(StructureDefinition) | 本プロファイルを識別するURLとバージョンを指定する。 http://jpfhir.jp/fhir/eCS/StructureDefinition/JP_Bundle_CLINS|x.y.z を設定する(|x.y.z は(U+007C)パイプ文字(縦棒文字)とバージョンx.y.zを指定する)。|x.y.z のバージョン表記は省略可能で、省略した場合には、受信側により受信時点での最新バージョンに準拠しているとみなされる。 |
固定値(x.y.zは置き換える) | http://jpfhir.jp/fhir/clins/StructureDefinition/JP_Bundle_CLINS|x.y.z | ||
meta | tag[*] | 1..* | Coding | 本リソースのメタデータ。 CLINSでのBundleリソースに含まれる6情報リソースカテゴリーをmeta.tag要素に記述する。 |
||||
meta | tag[+] | system | 1..1 | uri | 固定値 http://jpfhir.jp/fhir/clins/CodeSystem/BundleResourceType_CS を設定する。 | 固定値 | http://jpfhir.jp/fhir/clins/CodeSystem/BundleResourceType_CS | |
meta | tag[=] | code | 1..1 | code | Bundleリソースに含まれる6情報リソースカテゴリーのいずれかをhhttp://jpfhir.jp/fhir/clins/ValueSet/BundleResourceType_VSのValuseSetから設定する。 具体的には、"AllergyIntolerance"、"Condition"、"Observation"、"MedicationRequest" のいずれかの値を設定する。 |
例示 | "Observation" | |
identifier[*] | 1..* | Identifier | この文書Bundleの一意の識別子。Bundle作成時にシステムが設定する。 Bundleリソースのidentifier要素は、電子カルテ情報共有サービス側で保存される。送信側は、後続の送信においてこのidentifierを指定することで、受信側は過去に受信したBundleリソースを特定し、それに含まれていた全データについて削除、更新などの処理を行うためにこれを使用する。 |
|||||
identifier[+] | system | 1..1 | uri | 固定値 "http://jpfhir.jp/fhir/clins/bundle-identifier"を設定する。 | 固定値 | http://jpfhir.jp/fhir/clins/bundle-identifier | ||
identifier[=] | value | 1..1 | string | 実装ガイド本文 6情報送信仕様--Bundleリソースを識別するIdentifier要素-- に記載の[Bundle-ID]の仕様とする。 | 例示 | "1311234567^2020^00123456" | ||
type | 1..1 | code | Bundleリソースのタイプ。本仕様では"collection"固定とする。 | 固定値 | "collection" | |||
timestamp | 1..1 | instant | このリソースを生成した日時。時刻の精度はミリ秒とし、タイムゾーンを含めること。 | 例示 | "2021-02-01T13:28:17.239+09:00" | |||
entry[*] | 1..* | BackboneElement | Bundleに含まれる全リソースエントリを格納する。 | |||||
entry[+] | fullUrl | 1..1 | uri | エントリリスト内の各リソースを一意に識別するためのUUID。この要素は、第1リソースであるPatientリソースのentryのUUIDで、他のentryに記述されるリソースからこのPatientリソースを参照するときに、このUUIDを記述することで参照する。 | 例示 | "urn:uuid:179f9f7f-e546-04c2-6888-a9e0b24e5720" | ||
entry[=] | resource | 1..1 | Resource(JP_Patient_eCS) | JP_Patient_eCS profileに準拠したPatientリソース。最初のリソースentryはこのPatientリソースであることが必須。 | 例示 | { "resourceType": "Patient", "id": "InlineExample-Patient-standard", "meta": { "profile": [ "http://jpfhir.jp/fhir/eCS/StructureDefinition/JP_Patient_eCS" ] }, <以降省略> |
||
entry[+] | fullUrl | 0..1 | uri | エントリリスト内の各リソースを一意に識別するためのUUID。すでに送信済みのBundleリソースを削除するためにこのBundleリソースを送信する場合には、最初のentry(Patientリソース)だけを設定し、これ以降のリソースは不要である。 | 例示 | "urn:uuid:1304f64f-4e45-be12-ddd6-fab7895db0c3" | ||
entry[=] | resource | 0..* | Resource(JP_Conditon_eCS|JP_Observation_LabResult_eCS|JP_AllergyIntorellance_eCS) | このBundleリソースが格納するリソースのprofileに準拠したリソース。6情報のうち傷病名、薬剤アレルギー、その他アレルギー、検体のいずれか。処方は6情報送信においては送信対象となっていない。 | 例示 | { "resourceType": "Observation", "id": "InlineExample-Patient-standard", "meta": { "profile": [ "http://jpfhir.jp/fhir/eCS/StructureDefinition/JP_Observation_LabResult_eCS" ] }, <以降省略> |
||
::: (リソースインスタンスの数だけ繰り返し() | ||||||||
entry[+] | fullUrl | 0..1 | uri | エントリリスト内の各リソースを一意に識別するためのUUID。 | 例示 | "urn:uuid:3e6a0ba2-d781-4fd7-9de6-e077b690daed" | ||
entry[=] | resource | 0..* | entry[1]以降と同一。 | 上記と同じ。同一のBundleリソースに格納されるすべてのentryは、Patientリソースを除き同一のリソース種別、同一のプロファイルに準拠していなければならない。 | 例示 | { "resourceType": "Observation", "id": "InlineExample-Patient-standard", "meta": { "profile": [ "http://jpfhir.jp/fhir/eCS/StructureDefinition/JP_Observation_LabResult_eCS" ] }, <以降省略> |
Usage:
Bundleリソースのタイプ(type要素)は"collection"を使用する。
なお、CLINSに5情報を送信する場合には、ひとつのBundlleに格納されるリソースデータ同士を相互に参照する(一方のリソースデータから同じBundle内の他のリソースを参照する)ことについては、Patientリソースだけが許容されている。 その他のリソースデータの場合には、参照元のリソース・インスタンスのcontained要素に埋め込んでインラインリソースIDにより参照する()ことが必要である。
一方、2文書を送信する場合には、文書はそれぞれひとつの”document”タイプのBundleとして作成され、ひとつのBundlleに格納されるリソースデータ同士が特に制限なく相互参照できる。
Bundleリソースのプロファイルは以下を参照すること。
CLINS電子カルテ情報共有5情報用 Bundleリソース
Bundleリソースの概要図は下図のようになる。
Bundle概要図 |
---|
![]() |
1回で送信するひとつのBundleリソースには、
① 「その他アレルギー等」および「薬剤アレルギー等」 AllergyIntoleranceリソース
② 傷病名情報 Conditionリソース
③ 検査結果情報および感染症情報 Observationリソース
のいずれかひとつのリソースタイプのデータと、患者を識別するためのPatientリソース1個だけを格納する。
リソースの格納順序として、患者を識別するためのPatientリソース1個をまずBundleの最初のentryに格納し、以後は上記①から③ のいずれかひとつのリソースタイプのデータを原則として1個以上格納する。
** 複数のリソースタイプのデータをひとつのBundleリソースに混在させて送信することはできない(エラーとなる)**
①から③のどのリソースタイプをBundleリソースに格納しているかの情報を明示的に設定するため、Bundleリソースの meta.tagの次の値ペアを設定する。
1回で送信するBundleリソースには、ひとりの患者の、同時に1回で報告される一連のデータ(1報告単位のデータ)だけを、すべて漏れなく格納する。異なる報告単位のデータや、異なる患者のデータをひとつのBundleリソースに含めてはならない。
受信側(CLINS側)でデータ検証がなされる場合、1報告単位のデータはそのデータ全体がOKとなるか、全体が拒絶されるかどちらかとなる。1報告単位のデータのうち一部だけが検証にパスすることはない。
1報告単位のデータを別々のBundleリソースに分けて作成、送信したり、一部分だけ送信することはできない。もし、同じidentifier識別情報を持つBundleリソースが複数回送信された場合、最後に送信されたものだけが有効となり、それより過去に送信されたデータは削除されて上書きされるか、またはエラーとなる。
1報告単位のデータとは、情報種別により次のとおりとする。
なお、以下の説明では、終了日等とは、削除日、転帰日、完了日など、その患者に登録されていた当該情報が有効でなくなったとされた日を指す。ひとつの当該情報に終了日等が複数種類登録されている場合には、そのうち最も新しい(直近の)日付の情報とする。
①その他および「薬剤アレルギー等」(その他アレルギー等という)
1患者にその時点で登録されているか過去に登録されていたその他アレルギー等等のうち、以下のいずれかのものすべて。
②傷病名情報
1患者にその時点で登録されているか過去に登録されていた傷病名情報のうち、以下のいずれかのものすべて。
③ 検査結果情報および感染症情報
1患者の1回の検査結果報告で報告された一連の検査の結果が1報告単位となる。1回の検査結果報告で感染症情報とそれ以外の検査結果情報とが混在している場合にも、それらを区別せずに1報告単位のデータとみなしてよいが、別々の検査結果報告として異なる報告単位のデータとしてもよい。ただし、異なる報告単位のデータとするときは、異なるBundle.identifier識別情報とする必要がある。
Bundleリソースのidentifier要素は、CLINS側で保存される。送信側は、後続の送信において同じidentifierを使用することで、過去に送信したBundleリソース・インスタンスを削除、更新などの処理対象を指定できる。
Bundleリソースのidentifier要素は以下の通りとする。
この仕様を満たすidentifierに加えて、これとは異なるsystem値をもつidentifierは複数存在しても構わない。
Bundle.identifier.system : "http://jpfhir.jp/fhir/clins/bundle-identifier" を設定する。
Bundle.identifier.value : 以下に記載する[Bundle-ID] (旧報告単位ID)を設定する。
[Bundle-ID]: 次の3つの文字列を半角ハット記号(^)で連結した文字列。
{
"resourceType": "Bundle",
"id": "Bundle-for-Example01",
"meta":
{
:
<省略>
:
},
"identifier": [
{
"system": "http://jpfhir.jp/fhir/clins/bundle-identifier"
"value": "1311234567^2024^ORDLAB-20230301O102930492039"
},
:
<省略>
:
],
"type": "collection",
"timestamp": "2020-08-21T12:12:21+09:00",
"entry": [
{
"fullUrl": "f5f8bd72-4759-4fee-9cfe-4daf587abe68",
"resource": {
"resourceType": "Patient",
"id": "JP-Patient-10293894",
:
<患者基本情報を格納するPatientリソース内容>
:
}
},
{
"fullUrl": "f01d4ed2-a79f-bf5e-0232-5ae62dd34d63",
"resource": {
"resourceType": "Observation",
"id": "JP-Observation-Example001",
:
"subject": {
"reference": "f5f8bd72-4759-4fee-9cfe-4daf587abe68"
<上のUUIDは、上記PatientリソースのfullUrlの値を設定することで上記患者リソースを参照している。>
}
:
<1個目の検査結果><省略>
:
}
},
<2個目、3個目、...の検査結果Observationリソース>
]
}
Bundle.entry[] に繰り返しで格納される個々のリソース・インスタンスは、必ずBundle.entry[].fullUrl要素に、uuidをその都度毎回生成して異なる値を設定しなければならない。
1回で送信するひとつのBundleインスタンスの中に同一のuuidが存在してはならない(エラーとなる)。
同じリソースインスタンスを別のBundleリソースにより再送する場合は、前回送信時に使用したuuidをしてもよいが、新たに生成してもよい。
このuuidによるBundle内のentryの識別子(fullUrl)を、前回送信時の特定のentryの内容を受信側に指し示すための識別子として利用することはできない(受信側で保存していない)。
CLINSに送信した1報告単位のデータ(ひとつのBundleリソースにまとめて送信したデータ)は、この単位で全体を削除するか、更新(削除+新規登録)するかいずれかのみ行うことができる。1報告単位のデータのなかの特定のリソースだけを指定した削除や更新はできない。 対象となる送信済みのBundleリソース・インスタンスの指定は、前述した [Bundle-ID] により行う。
削除処理、更新処理: 削除要求コマンドまたは更新処理要求コマンドが、①被保険者個人識別子、②Bundle.identifier.system値、③Bundle.identifier.value値、の3つのパラメータとともに送信される。
削除要求の場合: 対象となるBundleリソースそのものは送信しない。共有サービスでは、①②③がすべて一致するBundleリソース・インスタンスのデータを削除する。
更新処理: 共有サービスでは、①②③がすべて一致するBundleリソース・インスタンスのデータを削除する。次に、送信されたBundleリソース・インスタンスのデータを登録する。
なお、CLINSでは、削除処理、更新処理のどの過程でも途中で失敗、エラーとなった場合には、全ての処理をロールバックし、処理前の状態に戻す。
以上のCLINSの処理要件を満たせるよう、Bundleリソースインスタンス、Patientリソースインスタンスには、本仕様に従って①②③を設定しなければならない。
Bundleリソースの電子カルテ情報サービスへの送信タイミングについては、CLINSの運用ルールに従うため、本IGの範囲外であるが、以下の方針を前提として本IGは作成されている。
① 「薬剤アレルギー等」「その他アレルギー等」の情報 AllergyIntoleranceリソース、および ② 傷病名情報 Conditionリソース
送信タイミングは、外来受診(複数診療科同日受診は1回とみなす)、入院、退院のイベントのあった日、およびこれらの情報が「新規登録または一部が更新、削除」(以下、「更新等」という)された時点ごととする。原則として、当該イベントや時点の当日中(翌朝までの夜間を含む)とする。
③ 検査結果情報および感染症情報 Observationリソース
送信タイミングは、これらの情報が更新等された時点ごととする。原則として、当該時点の当日中(翌朝までの夜間を含む)のなるべく早い時点が望ましいが、遅くとも次回診療日中(翌朝までの夜間を含む)とする。
詳細は、厚生労働省のホーページ「電子カルテ情報共有サービス」サイトの「電子カルテ情報共有サービスの導入に関するシステムベンダ向け技術解説書」の「原則->速やかな登録・取得」を参照。
特記事項なし