電子カルテ情報共有サービスFHIR実装ガイド JP-CLINS（CLinical Information Sharing ImplementationGuide） ドラフト版
0.9.13 - draft
Japan
電子カルテ情報共有サービスFHIR実装ガイド JP-CLINS（CLinical Information Sharing ImplementationGuide） ドラフト版 - Local Development build (v0.9.13) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
ここでのCLINS Validationとは、本仕様(JP CLINS IG)にもとづいて作成されたデータファイル（JSON形式）が、仕様の各Profile に準拠しているかをFHIR公式Validatorを使用して検証することである。なお、３文書のValidationは別に文書ごとにIGがあるため、別に記載する。
CLINS Validationの具体的手順と、出力の解釈方法について説明する。ただし、対象となるデータにあるさまざまなエラーや多様な記述方法によって、出力されるメッセージは多岐にわたるため、ここではその一部の例を示すに過ぎない。今後、順次説明を追加している予定である。
ここでのValidation手順は、手順（準備編）を完了すれば、
- zip形式 : https://jpfhir.jp/fhir/clins/pkgValidation/fhir-core-pkg.zip （42MB）
- tgz形式 : https://jpfhir.jp/fhir/clins/pkgValidation/fhir-core-pkg.tgz （28MB）
- fhir-core-pkgs-20231111-forV6.1.8-20230921 のような名前のフォルダが作成される。青字の部分はダウンロード時期により異なる。その中にpackagesフォルダが作成され、packagesフォルダ配下は以下のようなフォルダ構成になっていることを確認する。各フォルダ内にはさらにフォルダやファイルが存在するがここでは省略する。packageフォルダ内のフォルダ名や数は、ダウンロード時期による異なることがあるので、下図は一例である。
packages
├── hl7.fhir.r4.core#4.0.1
├── hl7.fhir.uv.extensions#1.0.0
├── hl7.fhir.uv.extensions.r4#1.0.0
├── hl7.fhir.xver-extensions#0.0.12
├── hl7.terminology#5.3.0
├── hl7.terminology.r5#5.0.0
└── packages.ini
既に.fhirというフォルダが存在する場合＊には、別名のフォルダに変えて保存しておいた上で、新たに.fhirを作成する。ドットで始まるファイルやフォルダは通常は非表示となっているため、Windows ファイルエクスプロラーではフォルダ表示オプションを変更して、隠しファイルを表示するモードに変更しておく。MacOSのFinderでは、[コマンドキー]＋[Shiftキー]＋[ドットキー]を押して隠しファイル表示モードに変更しておく。また、いずれのOSの場合も、これとは別に、ファイルの拡張子表示をONにして作業するのがわかりやすい。
＊注：.fhirというフォルダが存在するのは、このコンピュータ上でFHIR関連のツール（sushiコマンド、validatoreコマンドなど）を動作させたことがあることを示している。その内容フォルダ名が同一でもその内容が異なる場合があるため、本Validation作業に使う.fhirフォルダと内容を混在させないように注意することが必要である。そのため、ここでは既存の.fhirフォルダは名前を変えて保存している。
以下のようになる。
.fhir
└── packages
├── hl7.fhir.r4.core#4.0.1
├── hl7.fhir.uv.extensions#1.0.0
├── hl7.fhir.uv.extensions.r4#1.0.0
├── hl7.fhir.xver-extensions#0.0.12
├── hl7.terminology#5.3.0
├── hl7.terminology.r5#5.0.0
└── packages.ini
ここでは [vwork] と書く。次に [vwork] 直下に、以下の３つのフォルダを作成する。フォルダ名は自由だが、ここでは以下のように [xxxx] と記載する。
以下の３つのパッケージをOS種別にかかわらずダウンロードしする。(Windowsの場合も拡張子tgzのファイル）。ダウンロード後の解凍はしない。なお、ファイル名中のr4-x.x.xのバージョン番号部分はダウンロード時期により異なる。
jp-core.r4 パッケージ
jpfhir-terminology.r4 パッケージ
jp-clins.r4 パッケージ
直下ではなく、さらにサブフォルダを作成して配置してもよい。その場合には、以降では [targets] はそのサブフォルダを含めたパスであるとして読むこと。
以下のリンクからvalidator_cli.jarファイルを[prog]フォルダにダウンロードする。
備考： すべてのバージョンは以下より各バージョンの項目の Assets からダウンロードできる。
また、最新版は以下のリンクからダウンロードできる。
しかし、更新の頻度は非常に多く、時には最新版にバグがあって、数日後に修正版がリリースされたりするため、ある程度安定した版で、動作確認がとれており、本仕様のValidationに問題がない過去のバージョンを使うことを勧める。ここでは、v6.1.8 (2023.9.21)版を採用しているので、特に今後の変更記載がなく、他に理由がない限りこのバージョンをダウンロードすることを勧める。
以降では、Validationの手順を説明する。
Validation の実行
実行コマンド例 [vwork] フォルダに位置した状態で、以下を途中で改行せず、１行で入力する。
(行末の\は次行との継続の意味でいれてある記号である。１行で入力するので不要であれば削除すること)。適宜、バッチファイル（スクリプトファイル）を作成するとよい。
java -jar [prog]/validator_cli_6.1.8.jar \
[targets]/*.json \
-version 4.0.1 \
-language ja \
-locale ja-JP \
-want-invariants-in-messages \
-no-extensible-binding-warnings \
-display-issues-are-warnings \
-level warnings \
-best-practice ignore \
-tx n/a \
-ig [pkgClins]/jp-core.r4-1.1.2.tgz \
-ig [pkgClins]/jpfhir-terminology.r4-1.1.1.tgz \
-ig [pkgClins]/jp-clins.r4-0.9.11.tgz
上記のパラメータの説明は以下のとおり。
Validationコマンドのパラメータ説明
-version 4.0.1 : 適用するFHIRの基底仕様のバージョン。4.0.1を固定で指定する。
以下では、本IGに含まれる以下のサンプルファイルを対象に一括Validationを行った例を示す。
これらのJSONファイルと [targets]フォルダ内に配置して *.jsonを指定することにより実行する。
実行コマンド例：
java -jar ../work/validator_cli_6.1.8.jar ExampleJson/*.json -version 4.0.1 -language ja \
-ig pkgValidation/jp-core.r4#1.1.2.tgz -ig pkgValidation/jpfhir-terminology#1.1.1.tgz \
-ig pkgValidation/jp-clins.r4-0.9.11.tgz -locale ja-JP -tx n/a -want-invariants-in-messages \
-no-extensible-binding-warnings -display-issues-are-warnings -level warnings \
-best-practice ignore
出力結果を、説明の便宜上、[環境準備フェーズ]、[対象ファイルValidation途中フェーズ]、[結果報告フェーズ]の３つのブロックに分けて示す。
説明作成中
FHIR Validation tool Version 6.1.8 (Git# 8413995d8bcf). Built 2023-09-21T19:52:22.833Z (54 days old)
Java: 17.0.5 from /Library/Java/JavaVirtualMachines/jdk-17.0.5.jdk/Contents/Home on aarch64 (64bit). 4096MB available
Paths: Current = /Users/kohe/clinsVTest, Package Cache = /Users/kohe/.fhir/packages
Params: Targets/Condition-Example-JP-Condition-CLINS-eCS-01.json Targets/Condition-Example-JP-Condition-CLINS-eCS-02.json Targets/MedicationRequest-Example-JP-MedReq-ExtAnus-AsNeeded-Total1.json Targets/MedicationRequest-Example-JP-MedReq-ExtSkin-Total2.json Targets/MedicationRequest-Example-JP-MedReq-PO-BID-10days-AsNeeded.json Targets/Observation-ErrorExample-ObsLabo-eGFR.json Targets/Observation-Example-ObsLabo-Alb.json Targets/Observation-Example-ObsLabo-K.json Targets/Patient-Example-Patient-standard-ErrorInsuranceNo.json Targets/Patient-Example-Patient-standard.json -version 4.0.1 -language ja -locale ja-JP -want-invariants-in-messages -no-extensible-binding-warnings -display-issues-are-warnings -level warnings -best-practice ignore -tx n/a -ig pkgClins/jp-core.r4-1.1.2.tgz -ig pkgClins/jpfhir-terminology.r4-1.1.1.tgz -ig pkgClins/jp-clins.r4-0.9.11.tgz
Locale: 日本/JP
Jurisdiction: Japan
Loading
Load FHIR v4.0 from hl7.fhir.r4.core#4.0.1 - 4576 resources (00:03.302)
Load hl7.fhir.uv.extensions.r4#1.0.0 - 1328 resources (00:01.331)
Load hl7.terminology#5.3.0 - 4201 resources (00:00.704)
Load hl7.terminology.r5#5.0.0 - 4174 resources (00:00.566)
Load hl7.fhir.uv.extensions#1.0.0 - 1328 resources (00:00.840)
Terminology server null - Version n/a: No Terminology Server (00:00.000)
Load pkgClins/jp-core.r4-1.1.2.tgz - 159 resources (00:00.197)
Load pkgClins/jpfhir-terminology.r4-1.1.1.tgz - 175 resources (00:03.988)
Load pkgClins/jp-clins.r4-0.9.11.tgz - 148 resources (00:00.081)
Package Summary: [hl7.fhir.r4.core#4.0.1, hl7.fhir.xver-extensions#0.0.12, hl7.fhir.uv.extensions.r4#1.0.0, hl7.terminology#5.3.0, hl7.terminology.r5#5.0.0, hl7.fhir.uv.extensions#1.0.0]
Get set... go (00:01.131)
説明作成中
Validating
Validate Targets/Condition-Example-JP-Condition-CLINS-eCS-01.json
Validate Condition against http://hl7.org/fhir/StructureDefinition/Condition|4.0.1..........20..........40..........60..........80.........|
Validate Condition against http://jpfhir.jp/fhir/clins/StructureDefinition/JP_Condition_eCS..........20..........40..........60..........80..........100|
00:00.791
:
中略
:
Validate Targets/Patient-Example-Patient-standard.json
Validate Patient against http://hl7.org/fhir/StructureDefinition/Patient|4.0.1..........20..........40..........60..........80.........|
Validate Patient against http://jpfhir.jp/fhir/clins/StructureDefinition/JP_Patient_eCS..........20..........40..........60..........80..........100|
00:00.016
Done. Times: Loading: 00:12.264, validation: 00:01.189 (#10). Memory = 1Gb
説明作成中
-- ExampleJson/Condition-Example-JP-Condition-CLINS-eCS-01.json --------------------------------------------------------------------
Success: 0 errors, 0 warnings, 1 notes
Information: すべてOK
------------------------------------------------------------------------------------------------------------------------------------
-- ExampleJson/Condition-Example-JP-Condition-CLINS-eCS-02.json --------------------------------------------------------------------
Success: 0 errors, 2 warnings, 0 notes
Warning @ Condition.code.coding[0] (line 104, col8): http://jpfhir.jp/fhir/core/mhlw/CodeSystem/ICD10-2013-full#C169 の誤ったdisplay '胃の悪性新生物＜腫瘍＞，胃，部位不明' - 1 の選択肢のうちの一つであるべきです: '胃，部位不明' (言語 'ja' のため) for 'http://jpfhir.jp/fhir/core/mhlw/CodeSystem/ICD10-2013-full#C169'
Warning @ Condition.code.coding[0] (line 104, col8): http://jpfhir.jp/fhir/core/mhlw/CodeSystem/ICD10-2013-full#C169 の誤ったdisplay '胃の悪性新生物＜腫瘍＞，胃，部位不明' - 1 の選択肢のうちの一つであるべきです: '胃，部位不明' (言語 'ja' のため)
------------------------------------------------------------------------------------------------------------------------------------
-- ExampleJson/MedicationRequest-Example-JP-MedReq-ExtAnus-AsNeeded-Total1.json ------------------------------------------------------------------------------------
Success: 0 errors, 4 warnings, 0 notes
Warning @ MedicationRequest.medication.ofType(CodeableConcept).coding[0] (line 158, col8): urn:oid:1.2.392.200119.4.403.1#104937401 の誤ったdisplay '新レシカルボン坐剤' - 1 の選択肢のうちの一つであるべきです: '新レシカルボン坐剤・ゼリア新薬' (ja) (言語 'ja' のため) for 'urn:oid:1.2.392.200119.4.403.1#104937401'
Warning @ MedicationRequest.medication.ofType(CodeableConcept) (line 156, col4): urn:oid:1.2.392.200119.4.403.1#104937401 の誤ったdisplay '新レシカルボン坐剤' - 1 の選択肢のうちの一つであるべきです: '新レシカルボン坐剤・ゼリア新薬' (ja) (言語 'ja' のため)
Warning @ MedicationRequest.medication.ofType(CodeableConcept).coding[0] (line 158, col8): urn:oid:1.2.392.200119.4.403.1#104937401 の誤ったdisplay '新レシカルボン坐剤' - 1 の選択肢のうちの一つであるべきです: '新レシカルボン坐剤・ゼリア新薬' (ja) (言語 'ja' のため)
Warning @ MedicationRequest.medication.ofType(CodeableConcept).coding[1].system (line 165, col80): URL値 'http://jpfhir.jp/fhir/eCS/CodeSystem/DrugCode/19911234567' は解決できません
--------------------------------------------------------------------------------------------------------------------------------------------------------------------
-- ExampleJson/MedicationRequest-Example-JP-MedReq-ExtSkin-Total2.json ---------------------------------------------------------------------------
Success: 0 errors, 1 warnings, 0 notes
Warning @ MedicationRequest.medication.ofType(CodeableConcept).coding[0].system (line 131, col80): URL値 'http://jpfhir.jp/fhir/eCS/CodeSystem/DrugCode/19911234567' は解決できません
--------------------------------------------------------------------------------------------------------------------------------------------------
-- ExampleJson/MedicationRequest-Example-JP-MedReq-PO-BID-10days-AsNeeded.json -----------------------------------------------------------------------------------
Success: 0 errors, 1 warnings, 0 notes
Warning @ MedicationRequest.medication.ofType(CodeableConcept).coding[0].system (line 163, col80): URL値 'http://jpfhir.jp/fhir/eCS/CodeSystem/DrugCode/19911234567' は解決できません
------------------------------------------------------------------------------------------------------------------------------------------------------------------
-- ExampleJson/Observation-ErrorExample-ObsLabo-eGFR.json --------------------------------------------------------------
*FAILURE*: 1 errors, 0 warnings, 0 notes
Error @ Observation.code (line 35, col4): Observation.code.coding:localLaboCode: 最小必要値 = 1、見つかった値 = 0 (from http://jpfhir.jp/fhir/clins/StructureDefinition/JP_Observation_LabResult_eCS)
------------------------------------------------------------------------------------------------------------------------
-- ExampleJson/Observation-Example-ObsLabo-Alb.json --------------------------------------------------------
Success: 0 errors, 1 warnings, 0 notes
Warning @ Observation.code.coding[0].system (line 51, col94): URL値 'http://jpfhir.jp/fhir/clins/CodeSystem/JP_CLINS_ObsLabResult_LocalCode_CS' は解決できません
------------------------------------------------------------------------------------------------------------
-- ExampleJson/Observation-Example-ObsLabo-K.json ------------------------------------------------------
Success: 0 errors, 4 warnings, 0 notes
Warning @ Observation.code.coding[2] (line 60, col8): urn:oid:1.2.392.200119.4.504#3H015000002326101 の誤ったdisplay 'K' - 1 の選択肢のうちの一つであるべきです: 'カリウム_血清_電位差測定_定量値' (言語 'ja' のため) for 'urn:oid:1.2.392.200119.4.504#3H015000002326101'
Warning @ Observation.code (line 48, col4): urn:oid:1.2.392.200119.4.504#3H015000002326101 の誤ったdisplay 'K' - 1 の選択肢のうちの一つであるべきです: 'カリウム_血清_電位差測定_定量値' (言語 'ja' のため)
Warning @ Observation.code.coding[0].system (line 51, col94): URL値 'http://jpfhir.jp/fhir/clins/CodeSystem/JP_CLINS_ObsLabResult_LocalCode_CS' は解決できません
Warning @ Observation.code.coding[2] (line 60, col8): urn:oid:1.2.392.200119.4.504#3H015000002326101 の誤ったdisplay 'K' - 1 の選択肢のうちの一つであるべきです: 'カリウム_血清_電位差測定_定量値' (言語 'ja' のため)
--------------------------------------------------------------------------------------------------------
-- ExampleJson/Patient-Example-Patient-standard-ErrorInsuranceNo.json --------------------------------------------------------------------------
*FAILURE*: 1 errors, 0 warnings, 0 notes
Error @ Patient (line 1, col2): Rule valid-value-insurance-patientIdentifier: 'identifier.value 被保険者識別子情報の形式は、"保険者等番号:被保険者記号:被保険者番号:被保険者証等枝番"で、それぞれ半角英数字8桁固定、半角または全角文字列(空白を含まない)、半角または全角文字列(同)、半角数字2桁固定(1文字目は0)であり、それぞれ存在しない場合には、空文字列とする。' Failed (defined in http://jpfhir.jp/fhir/clins/StructureDefinition/JP_Patient_eCS) (inv = ((identifier.where(system = 'http://jpfhir.jp/fhir/clins/Idsystem/JP_Insurance_memberID').count() = 1) and identifier.where(system = 'http://jpfhir.jp/fhir/clins/Idsystem/JP_Insurance_memberID').value.matches('^[0-9]{8}:[^:^\\s^\u3000]*:[^:^\\s^\u3000]*:0[0-9]$'))) (log: (inv = ((identifier.where(system = 'http://jpfhir.jp/fhir/clins/Idsystem/JP_Insurance_memberID').count() = 1) and identifier.where(system = 'http://jpfhir.jp/fhir/clins/Idsystem/JP_Insurance_memberID').value.matches('^[0-9]{8}:[^:^\\s^\u3000]*:[^:^\\s^\u3000]*:0[0-9]$'))))
------------------------------------------------------------------------------------------------------------------------------------------------
-- ExampleJson/Patient-Example-Patient-standard.json ---------------------------------------------------------
Success: 0 errors, 0 warnings, 1 notes
Information: すべてOK
--------------------------------------------------------------------------------------------------------------
Done. Times: Loading: 00:17.636, validation: 00:18.173 (#10). Max Memory = 4Gb