退院時サマリーFHIR記述仕様 実装ガイド
1.1.6 - release
Japan
退院時サマリーFHIR記述仕様 実装ガイド - Local Development build (v1.1.6) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
ここでの Validationとは、本仕様(JP eDischargeSummary IG)にもとづいて作成されたデータファイル(JSON形式)が、仕様の各Profile に準拠しているかをFHIR公式Validatorを使用して検証することである。退院時サマリーBundleリソースデータ全体の1ファイルを検証することもできるが、Bundleリソースに埋め込まれるこ個々の構成リソースデータ(たとえば、ひとつのObservationリソースデータ)のファイルだけを検証することもできる。
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] 直下に、以下の3つのフォルダを作成する。フォルダ名は自由だが、ここでは以下のように [xxxx] と記載する。
以下の3つのパッケージをOS種別にかかわらずダウンロードしする。(Windowsの場合も拡張子tgzのファイル)。ダウンロード後の解凍はしない。なお、ファイル名中のr4-x.x.xのバージョン番号部分はダウンロード時期により異なる。
jp-core.r4 パッケージ
jpfhir-terminology.r4 パッケージ
jp-eDischargeSummary.r4 パッケージ
直下ではなく、さらにサブフォルダを作成して配置してもよい。その場合には、以降では [targets] はそのサブフォルダを含めたパスであるとして読むこと。
以下のリンクからvalidator_cli.jarファイルを[prog]フォルダにダウンロードする。
備考: すべてのバージョンは以下より各バージョンの項目の Assets からダウンロードできる。
また、最新版は以下のリンクからダウンロードできる。
しかし、更新の頻度は非常に多く、時には最新版にバグがあって、数日後に修正版がリリースされたりするため、ある程度安定した版で、動作確認がとれており、本仕様のValidationに問題がない過去のバージョンを使うことを勧める。ここでは、v6.1.8 (2023.9.21)版を採用しているので、特に今後の変更記載がなく、他に理由がない限りこのバージョンをダウンロードすることを勧める。
以降では、Validationの手順を説明する。
Validation の実行
実行コマンド例 [vwork] フォルダに位置した状態で、以下を途中で改行せず、1行で入力する。
(行末の\は次行との継続の意味でいれてある記号である。1行で入力するので不要であれば削除すること)。適宜、バッチファイル(スクリプトファイル)を作成するとよい。
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 [pkgJp]/jp-core.r4-1.1.2.tgz \
-ig [pkgJp]/jpfhir-terminology.r4-1.1.1.tgz \
-ig [pkgJp]/jp-eDischargeSummary.r4-1.1.6.tgz
上記のパラメータの説明は以下のとおり。
Validationコマンドのパラメータ説明
-version 4.0.1 : 適用するFHIRの基底仕様のバージョン。4.0.1を固定で指定する。
省略(作成中)