FHIR開発者の皆さん、こんにちは!
IRIS の FHIR リポジトリは、HL7 FHIR 標準プロファイルに対する検証をサポートしていますが、カスタムプロファイルに対する検証は、まだサポートできていません(将来のリリースバージョンで対応予定です)。
カスタムプロファイルの Search Parameter の追加はサポートしています!詳しくは、「動画:FHIR プロファイル」をご参照ください。
この記事では、IRIS の FHIR リポジトリに対して、カスタムプロファイルの検証を行う方法についてご紹介します。
方法としては、HL7 FHIR が提供している FHIR Validator で提供しているJARファイル(validator_cli.jar)を利用します。
利用のためには、FHIR リソースの検証のタイミングで、JARファイルの検証を実行するようにFHIRサーバサイドの動作をカスタマイズする必要があります。
ということで、大まかな準備は以下の通りです。
1) Java用外部サーバ(External Language Servers)の開始
IRISから FHIR Validator で提供しているJARファイル(validator_cli.jar)を利用するため、Java用外部サーバを開始します。
2) 検証ロジックを加工する
FHIRリポジトリのデフォルトの動作を変更するため、FHIRサーバーサイドのカスタマイズクラス群を用意します(サンプルをご提供しています)。
イメージは以下の通りです。
今回は、FHIRリソースの検証を外部のJARファイルで行うため、FHIRサーバーサイドの加工(絵の青い破線の部分)を行いますが、この他にも、
「このリソースに〇〇というデータがあるときは登録させたくない」
「このリソースに△△のデータが含まれているときは応答として返したくない」
や、
患者さんのお名前を匿名化したい!
のような実装を行う場合も、同様に、カスタマイズクラス群を作成します。
この記事では、外部の検証機能を使用するようにカスタマイズする流れをご紹介しますが、その他のカスタマイズ内容詳細については、以下記事をご参照ください。
「このリソースに〇〇というデータがあるときは登録させたくない」や「このリソースに△△のデータが含まれているときは応答として返したくない」のカスタマイズ例を紹介しています。
患者さんのお名前を匿名化するカスタムオペレーションの作成例を紹介しています。
デモをご覧いただく場合は、こちらのビデオをご覧ください。
それでは、具体的な手順をご紹介します。サンプルはこちら👉 https://github.com/Intersystems-jp/FHIRValidation-Test
事前準備:最初に、FHIR ValidatorのJARを利用して検証のテストを行います。
[1] JARのダウンロード
validator_cli.jar を https://github.com/hapifhir/org.hl7.fhir.core/releases/latest/download/validator_cli.jar からダウンロードします。
サンプル一式をgit cloneまたはダウンロードいただいた場合は、lib にJARを配置してください。
もちろん、任意ディレクトリに配置することもできますが、JARの呼び出しをまとめたJavaサンプルコードのコンパイルなどを簡単に行っていただくため、compile.bat/compile.sh をご用意しています。
この bat/sh の中でJARの場所を指定してるので、サンプルをそのままご利用いただく場合は、lib 以下に配置してください。
[2] JDKのバージョンの確認
JDKのバージョンについては、https://confluence.hl7.org/pages/viewpage.action?pageId=35718580#UsingtheFHIRValidator-JDKVersion
をご確認ください。
例では、OpenJDK11をインストールして利用しています。IRISがサポートするJDKについては、こちらをご参照ください。(8と11をサポートしています)
[3]-1 JARの呼び出しをまとめたJavaファイルの準備(Windows)
1. 事前準備
環境変数 JAVA_HOMEにJavaインストールディレクトリを設定します。
2. JavaValidatorFacade.java をコンパイルする
.\compile.bat
3. Jarファイルを作る
.\updateJar.bat
[3]-2 JARの呼び出しをまとめたJavaファイルの準備(Linux)
1. JavaValidatorFacade.java をコンパイルする
./compile.sh
2. Jarファイルを作る
./updateJar.sh
[4]検証のテスト
検証初回実行時、標準プロファイルのパッケージがない場合、https://confluence.hl7.org/display/FHIR/FHIR+Package+Cache からスキーマをダウンロードするため初回のみ時間がかかります。
Windows の場合、以下ディレクトリに保存されます(通常のユーザの場合)。
- C:\Users<username>.fhir
Linuxの場合、以下ディレクトリに保存されます。
- ~/.fhir
サンプルファイル(test_Patient.json)を利用してテストを行います。
実行例).\run.bat または ./run.sh <プロファイルのJSONがあるディレクトリ> <テストするリソースのJSON>
《メモ》
run.bat/run.sh の第1引数はカスタムプロファイル用ファイルを配置する予定のディレクトリを指定します(空でも実行できます)。
例では、fhirprofileを指定しています。
以下、Windowsでの実行例です(WindowsとLinuxとで出力内容に違いはありません。)。
1つのワーニングが出ていますが、Success と返ります。
(ワーニングの理由:meta.profileに指定しているURLが実在しないため)
PS C:\WorkSpace\FHIRValidation-Test> .\run.bat C:\WorkSpace\FHIRValidation-Test\fhirprofile\ C:\WorkSpace\FHIRValidation-Test\sample\test_Patient.json
C:\WorkSpace\FHIRValidation-Test>"C:\Program Files\jdk-11\bin\java" -cp lib\validator_cli.jar;lib\JavaValidatorFacade.jar ISJSample.JavaValidatorFacade C:\WorkSpace\FHIRValidation-Test\fhirprofile\ C:\WorkSpace\FHIRValidation-Test\sample\test_Patient.json
Load hl7.terminology.r4#4.0.0 - 4164 resources (00:04.784)
Load C:\WorkSpace\FHIRValidation-Test\fhirprofile - 0 resources (00:00.005)
Validate C:\WorkSpace\FHIRValidation-Test\sample\test_Patient.json
Validate Patient against http://hl7.org/fhir/StructureDefinition/Patient..........20..........40..........60..........80.........|
00:00.485
Success: 0 errors, 1 warnings, 1 notes
{
"resourceType" : "OperationOutcome",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table class=\"grid\"><tr><td><b>Severity</b></td><td><b>Location</b></td><td><b>Code</b></td><td><b>Details</b></td><td><b>Diagnostics</b></td><td><b>Source</b></td></tr><tr><td>INFORMATION</td><td/><td>Structural Issue</td><td>Canonical URL 'http://intersystems.com/fhir/ISJSample/StructureDefinition/JP_Patient' does not resolve</td><td/><td>No display for Extension</td></tr><tr><td>WARNING</td><td/><td>Structural Issue</td><td>Profile reference 'http://intersystems.com/fhir/ISJSample/StructureDefinition/JP_Patient' has not been checked because it is unknown, and the validator is set to not fetch unknown profiles</td><td/><td>No display for Extension</td></tr></table></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/operationoutcome-file",
"valueString" : "C:\\WorkSpace\\FHIRValidation-Test\\sample\\test_Patient.json"
}],
"issue" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/operationoutcome-issue-line",
"valueInteger" : 6
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/operationoutcome-issue-col",
"valueInteger" : 8
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/operationoutcome-issue-source",
"valueCode" : "InstanceValidator"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/operationoutcome-message-id",
"valueCode" : "TYPE_SPECIFIC_CHECKS_DT_CANONICAL_RESOLVE"
}],
"severity" : "information",
"code" : "structure",
"details" : {
"text" : "Canonical URL 'http://intersystems.com/fhir/ISJSample/StructureDefinition/JP_Patient' does not resolve"
},
"expression" : ["Patient.meta.profile[0]"]
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/operationoutcome-issue-line",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/operationoutcome-issue-col",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/operationoutcome-issue-source",
"valueCode" : "InstanceValidator"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/operationoutcome-message-id",
"valueCode" : "VALIDATION_VAL_PROFILE_UNKNOWN_NOT_POLICY"
}],
"severity" : "warning",
"code" : "structure",
"details" : {
"text" : "Profile reference 'http://intersystems.com/fhir/ISJSample/StructureDefinition/JP_Patient' has not been checked because it is unknown, and the validator is set to not fetch unknown profiles"
},
"expression" : ["Patient.meta.profile[0]"]
}]
}
続いて、test_Patient.json 15行目の gender に不正な値(例では"Man")を設定し、検証エラーが発生するか確認します。
今度は FAILUREと表示されます。(先ほどと同じワーニングに対するメッセージは省いています。)
PS C:\WorkSpace\FHIRValidation-Test> .\run.bat C:\WorkSpace\FHIRValidation-Test\fhirprofile\ C:\WorkSpace\FHIRValidation-Test\sample\test_Patient.json
C:\WorkSpace\FHIRValidation-Test>"C:\Program Files\jdk-11\bin\java" -cp lib\validator_cli.jar;lib\JavaValidatorFacade.jar ISJSample.JavaValidatorFacade C:\WorkSpace\FHIRValidation-Test\fhirprofile\ C:\WorkSpace\FHIRValidation-Test\sample\test_Patient.json
Load C:\WorkSpace\FHIRValidation-Test\fhirprofile2 - 0 resources (00:00.004)
Validate C:\WorkSpace\FHIRValidation-Test\sample\test_Patient.json
Validate Patient against http://hl7.org/fhir/StructureDefinition/Patient..........20..........40..........60..........80.........|
00:00.428
*FAILURE*: 1 errors, 1 warnings, 1 notes
{
"resourceType" : "OperationOutcome",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table class=\"grid\"><tr><td><b>Severity</b></td><td><b>Location</b></td><td><b>Code</b></td><td><b>Details</b></td><td><b>Diagnostics</b></td><td><b>Source</b></td></tr><tr><td>ERROR</td><td/><td>Invalid Code</td><td>The value provided ('man') is not in the value set 'AdministrativeGender' (http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1), and a code is required from this value set) (error message = Unknown Code http://hl7.org/fhir/administrative-gender#man in http://hl7.org/fhir/administrative-gender)</td><td/><td>No display for Extension</td></tr><tr><td>INFORMATION</td><td/><td>Structural Issue</td><td>Canonical URL 'http://intersystems.com/fhir/ISJSample/StructureDefinition/JP_Patient' does not resolve</td><td/><td>No display for Extension</td></tr><tr><td>WARNING</td><td/><td>Structural Issue</td><td>Profile reference 'http://intersystems.com/fhir/ISJSample/StructureDefinition/JP_Patient' has not been checked because it is unknown, and the validator is set to not fetch unknown profiles</td><td/><td>No display for Extension</td></tr></table></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/operationoutcome-file",
"valueString" : "C:\\WorkSpace\\FHIRValidation-Test\\sample\\test_Patient.json"
}],
"issue" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/operationoutcome-issue-line",
"valueInteger" : 15
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/operationoutcome-issue-col",
"valueInteger" : 21
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/operationoutcome-issue-source",
"valueCode" : "TerminologyEngine"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/operationoutcome-message-id",
"valueCode" : "Terminology_TX_NoValid_16"
}],
"severity" : "error",
"code" : "code-invalid",
"details" : {
"text" : "The value provided ('man') is not in the value set 'AdministrativeGender' (http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1), and a code is required from this value set) (error message = Unknown Code http://hl7.org/fhir/administrative-gender#man in http://hl7.org/fhir/administrative-gender)"
},
"expression" : ["Patient.gender"]
},
ここまでで、 FHIR Validator から提供されているJARを利用した検証のテストは完了です。
ここからは、IRIS の FHIRサーバーサイドのカスタマイズを行っていきます。
<カスタマイズ概要>
1) Java用外部サーバ(External Language Servers)の開始
2) 検証ロジックを加工する
まずは、1) Java用外部サーバ(External Language Servers)の開始 を行うための手順をご紹介します。
[5] ISJSample.JavaValidatorFacade クラスを実行するためJava用外部サーバを起動
実行環境に合わせて設定を追加します。
管理ポータル > システム管理 > 構成 > 接続性 > External Lanaugae Server > %Java Server
設定項目 | 値 |
クラスパス | validator_cli.jarとJavaValidatorFacade.jarのパス |
Java Home Directory | Javaのインストールディレクトリ |
(図例はWindowsでの例です)
設定が終わったら start のリンクをクリックします。以下のようなログが表示されます。
Start External Language Server %Java Server:
お待ちください...結果が以下に表示されます:
2022-10-07 19:48:59 Starting Java Gateway Server '%Java Server'
2022-10-07 19:48:59 Executing O.S. command: C:\Program Files\jdk-11\bin\java.exe -Xrs -Djava.system.class.loader=com.intersystems.gateway.ClassLoader -classpath C:\WorkSpace\FHIRValidation-Test\lib\validator_cli.jar;C:\WorkSpace\FHIRValidation-Test\lib\JavaValidatorFacade.jar;C:\InterSystems\IRISHealth\dev\java\lib\1.8\intersystems-jdbc-3.3.1.jar com.intersystems.gateway.JavaGateway 53272 "" "JP7430MIIJIMA:IRISHEALTH:%Java Server" 127.0.0.1 ""
2022-10-07 19:49:10 Execution returned: ''
2022-10-07 19:49:10 Gateway Server start-up confirmation skipped
2022-10-07 19:49:10 Starting background process to monitor the Gateway Server
2022-10-07 19:49:10 Job command successful, started monitor process '26376'
ここからは、2) 検証ロジックを加工する を行うための手順をご紹介します。
[6]FHIRリポジトリのカスタマイズ用クラスの準備
以下説明は、IRIS for Health 2022.1を利用した例で記載しています。
詳細はドキュメント:FHIRサーバのカスタマイズ もご参照ください。
!!FHIRリポジトリを作成する前に、ネームスペースにカスタマイズ用クラス群を準備する必要があります!!
サンプルでは、以下の説明に登場するクラス群をISJSample以下に用意しています。インポート方法は 「5.インポート」をご参照ください。
1. クラス一覧
それぞれのクラスの関係は以下のイメージです。
2.作成したクラスにパラメータを設定
最初から作成される場合は、以下のクラスパラメータを設定してください。サンプルをそのままご利用いただく場合は修正不要です。
1で作成したクラスにパラメータを設定します。
- ISJSample.FHIRValidationInteractions クラス
- ResourceValidatorClassに検証実行用カスタムクラス名(ISJSample.FHIRResourceValidator)を指定
- BatchHandlerClassにBundleのtype=batchまたはtransactionを処理するカスタムクラス名(ISJSample.FHIRBundleProcessor)を指定
- ISJSample.FHIRValidationInteractionsStrategy クラス
- StrategyKeyにInteractionsStrategyの一意の識別子を指定
- InteractionsClassにInteractionsのカスタムクラス名(ISJSample.FHIRValidationInteractions)を指定
- ISJSample.FHIRBundleProcessor クラス
- BundleValidatorClassにBundle検証用カスタムクラス名(ISJSample.FHIRBundleValidator)を指定
- ISJSample.FHIRValidationRepoManager クラス
- StrategyClassに InteractionStrategyのカスタムクラス名(ISJSample.FHIRValidationInteractionsStrategy)を指定
- StrategyKeyにInteratcionsStrategyで指定したStrategyKeyの値を指定
《補足》
この他、ISJSample.FHIRValidationInteractionsクラスとISJSample.FHIRResourceValidatorクラスでメソッドをオーバーライドしています。
- ISJSample.FHIRValidationInteractionsクラスでは、Bundleに含まれるリソースに対して検証が2回呼び出されないように StartTransactionBundle()メソッドとEndTransactionBundle()メソッドのオーバーライドしています。 %inTransactionFlag変数の設定を追加
Method StartTransactionBundle(pBundleTransactionId As %Integer)
{
do ##super(pBundleTransactionId)
set %inTransactionFlag=$$$YES
}
Method EndTransactionBundle()
{
kill %inTransactionFlag
do ##super()
}
- ISJSample.FHIRResourceValidatorクラスでは、ValidateResource()をオーバーライドしています。 %inTransactionFlgが$$$YES ではないとき、検証を実行するように変更
Method ValidateResource(pResourceObject As %DynamicObject)
{
//do ##super(pResourceObject)
if $get(%inTransactionFlag,$$$NO)'=$$$YES {
do ##class(ISJSample.FHIRValidation).validate(pResourceObject)
}
}
- ISJSample.FHIRBundleValidator クラスでは、スーパークラスのValidateBundle()をオーバーライドし、ISJSample.FHIRValidationクラスのvalidate()を呼び出しています。
ClassMethod ValidateBundle(pResourceObject As %Library.DynamicObject, pFHIRVersion As %String)
{
//do ##super(pResourceObject,pFHIRVersion)
do ##class(ISJSample.FHIRValidation).validate(pResourceObject)
}
3. カスタム検証用クラス(ISJSample.FHIRResourceValidator)の修正
最初から作成される場合は、以下のクラスパラメータを設定してください。サンプルをそのままご利用いただく場合は修正不要です。
スーパークラスのValidateResource()をオーバーライドし、ISJSample.FHIRValidationクラスのvalidate()を呼びしています。
4.カスタム検証用クラスが使用するパラメータ値の設定
管理ポータル > Health > 作成したネームスペース > Configuration Registry に移動し、以下のKeyとValueを設定します。
項目名(Key) | 設定例(Value) | 意味 |
/FHIR/Validation/SkipIfNoProfile | 1 |
設定値 1:検証をスキップする(リソースのmeta.profileの値が空や設定されていない場合に、検証をスキップする設定です。) 設定値 0:検証をスキップしない |
/FHIR/Validation/JavaGatewayServer | 127.0.0.1 | Java用外部サーバのIPアドレスまたはサーバ名 |
/FHIR/Validation/JavaGatewayPort | 53272 | Java用外部サーバが使用するポート番号 |
/FHIR/Validation/ProfileLocation | C:\WorkSpace\FHIRValidation-Test\fhirprofile | カスタムプロファイルのディレクトリを指定(フルパス) |
/FHIR/Validation/TerminologyServer | (設定なし) | TerminologyサーバのURLを指定 |
5.サンプルクラスのインポート
- VSCodeをお使いの方は、対象ネームスペースに接続後、ISJSampleディレクトリ を右クリックし[Import and Compile]をクリックします(または、クラス定義を Ctrl + S で保存することでインポートできます)。
- スタジオをお使いの方は、対象ネームスペースに接続し、ISJSampleディレクトリ 以下 *.clsを複数選択し、スタジオのエリアにドラッグ&ドロップすることでインポートできます。
- 管理ポータルからインポートする場合は、管理ポータル > システムエクスプローラー > クラス > 対象ネームスペース選択 > [インポート]ボタンクリック で表示されるインポート画面でISJSampleディレクトリ を選択し、インポートを実行します。 詳細は図例をご参照ください。
[7]FHIRリポジトリの作成
InteratcionsStrategyクラスのカスタムクラスがコンパイル済であることを確認し、以下GUIで作成します。
管理ポータル > Health > 作成したネームスペース > FHIR Configuration > Server Configuration > Add Endpoint
!!Interactions sterategy classに作成したクラス名: ISJSample.FHIRValidationInteractionsStrategyを指定してからリポジトリを作成して下さい!!
リポジトリ作成後、デバッグモードから認証なし設定します(Debuggingの「Allow Unauthenticated Access」にチェック)
[8]テスト実行
Postmanで以下実行します。
通常のPOSTでテストしてもいいのですが、何度も同じリソースを使って検証のテストを行うような場合には、リソースの検証だけを行う $validate オペレーションの利用が便利です。
例では、URL末尾に /$validate をつけています。この指定があるだけとリソースの検証のみを行うことができます(/$validate をなくして実行すると通常のPOST要求の流れで検証が行われます)。
設定項目 | 値 |
URL | <エンドポイント>/Patient/$validate |
Method | POST |
Header | Content-Type に application/json+fhir;charset=utf-8 |
Body | PatientリソースのJSON |
結果は以下の通りです。
{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "information",
"code": "informational",
"diagnostics": "All OK",
"details": {
"text": "All OK"
}
}
]
}
Bundleの場合は以下の通りです。
設定項目 | 値 |
URL | <エンドポイント>/Bundle/$validate |
Method | POST |
Header | Content-Type に application/json+fhir;charset=utf-8 |
Body | Bundle用JSON |
ここまでで、手続きは完了です。
次は、いよいよ、カスタムプロファイルの検証を実行してみます!
[9]JPCoreのプロファイルを適用する方法
1.JPCoreのアーティファクトを用意する
公開されているJPCoreのプロファイル FHIR JP Core 実装ガイドパッケージをダウンロードされるか、公式Git を clone して、SUSHIを利用してImplementation Guide(IG)などのJSONのファイル群(アーティファクト)を作成する方法があります。
参照元:HL7FHIR JP Core実装ガイド<Draft Ver.1>の公開について(ご案内)
以下例は、2022年10月24日にダウンロードしたFHIR JP Core 実装ガイド V1.1.0 のパッケージを利用して記述しています。
※2022年11月5日にダウンロードした v1.1.1のパッケージでも以下の例が動作することを確認しています。
2. 1.で用意したアーティファクトをプロファイル配置用ディレクトリにコピーして検証を実行する
テストする場合は、run.bat または run.sh の第1引数にアーティファクトがあるディレクトリを指定します。
例では、 FHIR JP Core 実装ガイド にある V1.1のtgz版をダウンロードして展開したディレクトリにあるJSONファイルを fhirprofile以下にコピーした状態で実行しています。
以下、Windowsでの実行例です(WindowsとLinuxとで出力内容に違いはありません。)。
PS C:\WorkSpace\FHIRValidation-Test> .\run.bat C:\WorkSpace\FHIRValidation-Test\fhirprofile C:\WorkSpace\FHIRValidation-Test\sample\test_Patient-JPCore.json
C:\WorkSpace\FHIRValidation-Test>"C:\Program Files\jdk-11\bin\java" -cp lib\validator_cli.jar;lib\JavaValidatorFacade.jar ISJSample.JavaValidatorFacade C:\WorkSpace\FHIRValidation-Test\fhirprofile C:\WorkSpace\FHIRValidation-Test\sample\test_Patient-JPCore.json
Load hl7.terminology.r4#4.0.0 - 4164 resources (00:04.947)
Load C:\WorkSpace\FHIRValidation-Test\fhirprofile - 241 resources (00:00.465)
Unable to generate snapshot for http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationRequest: Attempt to use a snapshot on profile 'http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationRequestBase' as Base for generating a snapshot for the profile http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationRequest before it is generated
Unable to generate snapshot for http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationRequest_Injection: Attempt to use a snapshot on profile 'http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationRequestBase' as Base for generating a snapshot for the profile http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationRequest_Injection before it is generated
Unable to generate snapshot for http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationRequest: Profile JP_MedicationRequest (http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationRequest), element null. Error generating snapshot: Error sorting Differential: The element MedicationRequest.dosageInstruction is out of order (and maybe others after it)
Unable to generate snapshot for http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationRequest_Injection: Profile JP_MedicationRequest_Injection (http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationRequest_Injection), element null. Error generating snapshot: Error sorting Differential: The element MedicationRequest.dosageInstruction is out of order (and maybe others after it)
Validate C:\WorkSpace\FHIRValidation-Test\sample\test_Patient-JPCore.json
Validate Patient against http://hl7.org/fhir/StructureDefinition/Patient..........20..........40..........60..........80.........|
Validate Patient against http://jpfhir.jp/fhir/core/StructureDefinition/JP_Patient..........20..........40..........60..........80..........100|
00:00.641
Success: 0 errors, 0 warnings, 1 notes
{
"resourceType" : "OperationOutcome",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>All OK</p><table class=\"grid\"><tr><td><b>Severity</b></td><td><b>Location</b></td><td><b>Code</b></td><td><b>Details</b></td><td><b>Diagnostics</b></td></tr><tr><td>INFORMATION</td><td/><td>Informational Note</td><td>All OK</td><td/></tr></table></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/operationoutcome-file",
"valueString" : "C:\\WorkSpace\\FHIRValidation-Test\\sample\\test_Patient-JPCore.json"
}],
"issue" : [{
"severity" : "information",
"code" : "informational",
"details" : {
"text" : "All OK"
}
}]
}
実行に指定しているtest_Patient-JPCore.jsonには、JPCoreが定義しているextension.Race(患者の人種)の情報が含まれます。
例)
"birthDate": "1970-01-01",
"extension":[
{
"url": "http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Patient_Race",
"valueCodeableConcept": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-Race",
"code": "2039-6",
"display": "Japanese"
}
]
}
}
],
3. IRISから実行する。
実行前にカスタムプロファイルのアーティファクトがあるディレクトリが正確に設定されているか確認します。
IRISの管理ポータル > Health > ネームスペース選択 > Configuration Registry > /FHIR/Validation/ProfileLocation Valueを確認
《メモ》
Configuration Registry の Key には、ISJSample.FHIRValidationクラスに定義されているパラメータ名を設定しています。Value の取得は以下ユーティリティクラスのメソッドを実行することで取得できます。
##class(HS.Registry.Config).GetKeyValue(..#ProfileLocationKEY)
ObjectScriptObjectScript
設定値が管理ポータルで変更できるので、プロファイルを参照する場所を変える場合は、/FHIR/Validation/ProfileLocation を変更するだけでOKです。
以下、Postmanからのテスト例です。
設定項目 | 値 |
URL | <エンドポイント>/Patient/$validate |
Method | POST |
Header | Content-Type に application/json+fhir;charset=utf-8 |
Body | JPCore対応用PatientリソースのJSON |
検証がOKであることを確認したら、JPCoreのプロファイルを正しく認識しているかどうかテストするため、患者の人種(Race)の情報に誤ったデータタイプの情報を設定し検証します。
RaceのデータタイプはExtension(CodeableConcept)が指定されているため、valueCodeableConceptにCodeableConceptタイプの情報を持つ必要がありますが、以下の例では、valueStringにstringの情報を設定しています。
"extension":[
{
"url": "http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Patient_Race",
"valueString":"日本人"
}
],
以下、Postmanからのテスト例です。
設定項目 | 値 |
URL | <エンドポイント>/Patient/$validate |
Method | POST |
Header | Content-Type に application/json+fhir;charset=utf-8 |
Body | JPCore対応用PatientリソースのJSON:検証失敗用 |
例と同様に、JPCore V1.1のtgz版プロファイルを利用している場合のPatientリソース内タイプの確認については、https://jpfhir.jp/fhir/core/V1B/StructureDefinition-jp-patient.html をご参照ください。
RESTクライアントからの実行結果は以下の通りです。(CodeableConceptのタイプではなくstringの情報が来ていることでエラーが発生しています)
{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "error",
"code": "structure",
"diagnostics": "5001",
"details": {
"text": "This element does not match any known slice defined in the profile http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Patient_Race and slicing is CLOSED: Patient.extension[0].value.ofType(string): Does not match slice 'valueCodeableConcept' (discriminator: ($this is CodeableConcept))"
},
"expression": [
"Patient.extension[0].value.ofType(string)"
]
},
{
"severity": "error",
"code": "structure",
"diagnostics": "5001",
"details": {
"text": "The Extension 'http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Patient_Race' definition allows for the types [CodeableConcept] but found type string"
},
"expression": [
"Patient.extension[0]"
]
}
]
}
以上です!
最後までお読みいただきありがとうございました
今回の記事は、JP Coreのカスタムプロファイルの適用でご紹介しましたが、カスタムプロファイルの作成からコンパイルまでの手続きなどについては、以下の記事でご紹介しています。
- FHIRプロファイル作成ツールであるSUSHIの
握り方使い方を紹介している記事 👉 SUSHIを使ってFHIRプロファイルを作成しようパート1 - Extensionの追加と、Extensionで追加した項目に対するSearchParameterの定義を行い、IRISのFHIRリポジトリに適用し、新しいSearchParameterが利用できるまでの流れをご紹介している記事 👉 SUSHIを使ってFHIRプロファイルを作成しようパート2
ぜひご覧ください!