HL7 OTD の操作

OTD エディタは、選択されたオブジェクト型定義 (OTD) の構造を表示します。また、組み込み型のテスターでその処理を確認できます。エディタを使用して OTD の作成および変更を行うこともできます。オブジェクト型定義、OTD の構造、および OTD エディタの概要については、『Sun Enterprise Service Bus ユーザーガイド』を参照してください。その中では、使用可能なすべての OTD プロパティーを定義し、OTD エディタのすべての機能を説明しています。

次のセクションでは、OTD エディタでライブラリ OTD を使用する場合に固有の情報について説明します。これらの OTD は、業界固有のデータ交換システムおよびオープンソース標準で使用されるメッセージタイプに対応するテンプレートです。テンプレートは事前に定義されており、そのまま使用できるほか、OTD エディタを使用して変更することもできます。

• 「OTD エディタを使用した OTD の表示」

• 「OTD エディタを使用した OTD の変更」

OTD エディタを使用した OTD の表示

OTD エディタは、選択されたオブジェクト型定義 (OTD) の構造を表示します。また、組み込み型のテスターでその処理を確認できます。エディタを使用して、ユーザー定義の OTD を作成および変更することもできます。

OTD を表示する

OTD エディタを使用して HL7 汎用 OTD または HL7 ライブラリ OTD (HL7 アダプタを Sun HL7 OTD ライブラリと組み合わせて使用している場合) を表示するには、次の手順に従います。

1. Java CAPS のプロジェクトツリーで、Sun OTD ライブラリディレクトリ、HL7 ディレクトリ、該当する HL7 ライブラリバージョンのフォルダの順に展開します。ビルドにはインストールしたバージョンのみが表示されます。

2. プロジェクトエディタの OTD ライブラリにある使用可能な OTD は保護されています (読み取り専用)。現在の場所で OTD をダブルクリックすることで、OTD を「読み取り専用」モードで表示できます。

OTD をプロジェクトにコピーする

1. OTD を編集可能モードで表示するには、OTD をプロジェクトにコピー＆ペーストします。OTD を右クリックし、ショートカットメニューから「コピー」を選択して、次にプロジェクトを右クリックし、ショートカットメニューから「ペースト」を選択します。OTD がプロジェクトエクスプローラツリーのプロジェクトに追加されます。

2. コピーされた OTD を表示するには、コピーされた OTD をダブルクリックします。編集可能な OTD が OTD エディタに表示されます。ライブラリ OTD の場合、OTD セグメントは引き続き書き込み保護されています。この時点で、OTD プロパティーは、ルートノードからのみ変更できます (次の図を参照)。

   

3. エディタの「オブジェクト型定義」区画で、任意の OTD ノードまたはサブノードを選択すると、エディタの「プロパティー」区画にノードのプロパティーが表示されます。

   オブジェクト型定義、OTD の構造、および OTD エディタの概要については、『Sun Enterprise Service Bus ユーザーガイド』を参照してください。

OTD エディタを使用した OTD の変更

OTD のチェックアウトとチェックイン

汎用 HL7 OTDS (HL7 OTD ライブラリからインストールされる OTD) は、Project Explorer の Sun フォルダにあります。これらの OTD は保護されており、変更できません。これにより、元の OTD を常に元の形で使用できます。OTD を変更するには、まず OTD を「Sun」 > 「OTD ライブラリ」フォルダからプロジェクトにコピー＆ペーストします。

プロジェクトに保存したすべての OTD のバージョンを管理できます。OTD をチェックインまたはチェックアウトするには、プロジェクトエクスプローラツリーで OTD を右クリックし、ショートカットメニューから「バージョン管理」 > 「チェックアウト」または「チェックイン」を選択します。OTD がチェックインされると、プロジェクトエクスプローラツリーに OTD ファイルアイコンが「ロック」として表示されます (アイコンに赤い南京錠が含まれる)。

OTD のルートプロパティーの編集

プロジェクトにコピーした HL7 OTD は、ルートノードからのみ編集できます。OTD の各セグメントは書き込み保護されています。OTD セグメントは、OTD エディタの「参照」区画で見ることができます。この「参照」区画には、OTD ファイルの内部テンプレートおよび外部テンプレートが含まれます。ライブラリ OTD の特定のセグメントを編集する方法は、「OTD セグメントの追加および編集」を参照してください。OTD プロパティーの詳細は、「OTD プロパティー」を参照してください。

ルートノードのプロパティー

次の表に、ルートノードに関連付けられた一連のプロパティーを示します。

ルートノードから編集したプロパティーは、OTD に包括的に適用されます。たとえば、ルートノードから変更したレベル 3 の区切り文字は、レベル 3 のすべてのノードの区切り文字に適用されます。特定のセグメントのプロパティーは排他的に編集できますが、このためには、セグメントが参照する特定の OTD をプロジェクトにコピー＆ペーストします。特定のセグメントの編集については、「OTD セグメントの追加および編集」を参照してください。

HL7 OTD のルートノードプロパティーを編集する

1. OTD をプロジェクトにコピー＆ペーストします。OTD がプロジェクトエクスプローラツリーのプロジェクトに追加されます。

2. OTD をダブルクリックして、OTD エディタでプロジェクトを開きます。

3. エディタの「オブジェクト型定義」区画で、OTD のルートノードを選択します。エディタの「プロパティー」区画にルートプロパティーが表示されます。

4. 「プロパティー」区画で、プロパティーを編集する任意のプロパティーフィールドをクリックします。

OTD 区切り文字の編集

すべてのノードレベルの区切り文字は、ルートノードから設定 (および変更) します。デフォルトのレベル 1 の区切り文字は ASCII 以外の文字であることに注意してください。いったん変更すると、文字として入力し直すことはできません (ただし、ペーストは可能)。OTD の特定セグメントの編集については、「OTD セグメントの追加および編集」を参照してください。

ルートノードから区切り文字を編集する

1. OTD エディタで、「オブジェクト型定義」区画のルートノードを選択します (この例では ADT_A02 とします)。「プロパティー」区画で、delim プロパティーフィールドをダブルクリックします。省略記号 (...) ボタンがフィールドに表示されます。省略記号ボタンをクリックします。区切り文字リストエディタが表示されます (次の図を参照)。

   

2. OTD エディタの「プロパティー」フィールドでどのレベルのフィールドをダブルクリックしても、そのフィールドは編集可能になるか、またはオプションのリストが表示されます。レベル 3 の「区切り文字バイト」フィールドをダブルクリックします (前の図を参照)。現在の区切り文字をナンバー記号 (#) に変更し、次のフィールドに Tab で移動して、「了解」をクリックします。

   OTD に存在するレベル 3 のすべてのノードの区切り文字がナンバー記号 (#) になります。ただし、特定のセグメントで別途指定されている場合は除きます。次の図は、オブジェクト型定義ツリー内のさまざまなレベルの例をルートノードから示しています。

   

HL7 の標準エンコーディング文字の変更

すべての HL7 OTD には、HL7 標準の定義に従って、区切り文字の定義済みリストがあります。HL7 メッセージ内の区切りエンコーディング文字を変更する場合は、OTD エディタを使用してルートノードから OTD の区切り文字を変更して、HL7 メッセージで使用している区切り文字と一致させます。

区切りエンコーディング文字フィールドは、4 つのエンコーディング文字とフィールド区切り文字から構成される固定長フィールドです。5 番目 (追加) の文字は、セグメントのフィールド区切り文字として必要です。

エンコーディング文字と突き合わせた妥当性検査を行うには、次のように、事前に構築されたコラボレーションルールを変更します。

// first unmarshal the HL7 OTD payload



// then get the encoding character field:

String encodingChars = otdHL7_GENERIC_EVT_1.getMSH().getMsh2EncodingCharacters();



if (!encodingChars.equals(“<customer_encoding_characters>”)) {

validated = false;

ErrorMessage = "Validation Failure: Receiving Facility";

log( LOG_LEVEL_ERROR, "Validate HL7 Message failed: Encoding character field" );

}

区切り文字の指定

ノードは、外部データ表現内の階層化されたデータ構造内で、外部データ表現そのものと、その下位に使用される一連の区切り文字を定義します。ノードで区切り文字リストを定義している場合、上位の区切り文字リストは、このノード自体とその下位に一切影響しません。区切り記号リストは、通常、ルートノードに指定します。

たとえば、次のデータを解析する場合、

a^b|c^d|e

OTD を次のように定義できます。

• demo-otd

  • element1

    • field1

    • field2

  • element2

    • field3

    • field4

  • field5

この OTD の区切り文字リストは、demo-otd 要素で指定するため、OTD 全体に適用され、2 つのレベルを持ちます。

レベル 1

• 区切り文字 |

レベル 2

• 区切り文字 ^

レベル 1 の区切り文字は、2 つの要素およびフィールド 5 に適用され、レベル 2 の区切り文字はフィールド 1 から 4 に適用されます。

区切り文字リストは、この非常に簡単な例よりもずっと複雑になることがあります。たとえば、任意の特定レベルで異なるタイプの区切り文字を複数作成したり、例のようにルートノードでだけでなく、OTD 内の任意のノードで区切り文字リストを指定したりすることができます。区切り文字リストの作成手順については、「OTD エディタを使用した OTD の変更」を参照してください。

区切り文字のプロパティー

区切り文字は、区切り文字リストエディタを使用して定義します。

区切り文字のプロパティーと値を表 1–4 に示します。

タイププロパティー - Escape オプション

escape 区切り文字は、解析時に認識されて無視されるシーケンスです。その目的は、エスケープシーケンスの使用を許可して、データ内にバイトシーケンスを組み込むことで、この存在がないと、区切り文字の出現として見なされます。

たとえば、あるレベルに通常の区切り文字「+」が存在し、エスケープ区切り文字「\+」を定義した場合、aaa+b\+c+dddは 3 つのフィールド、aaa、b\+c、および ddd として解析されます。エスケープ区切り文字を定義しなかった場合、シーケンスは 4 つのフィールド、aaa、b\、c、および ddd として解析されます。

ただし、あるレベルでエスケープ区切り文字が 1 つのみの場合、delim および array ノードでは区切り文字の定義されていない状態を表します。

区切り文字バイト

基本的には、区切り文字として使用できる文字に制限はありません。ただし、データと混同する可能性のある文字や、エスケープシーケンスと衝突する文字は避けてください。バックスラッシュ (\) は通常、エスケープ文字として使用されます。HL7 プロトコルは、エスケープシーケンスの一部に二重のバックスラッシュを使用して特別なテキストフォーマット指示を与えます。

コロン (:) は区切り文字として使用しないでください。コロンは、システムが生成した時刻文字列でリテラルとして使用されます。これは、ドメインのシャットダウン後などの復旧手順を妨げる可能性があります。

ターミネータモードプロパティー

前の例に示したツリー構造を見てみましょう。この構造では、ノード a はその区切り文字としてパイプ (|) を、サブノード b はその区切り文字としてチルダ (~) を、サブノード c はその区切り文字としてアスタリスク (*) を持っています。

オプションモードプロパティー

次の図に示したツリー構造を見てみましょう。この構造では、ノード a はその区切り文字としてパイプ (|) を、サブノード b、c、および d はいずれもその区切り文字としてアスタリスク (*) を持っています。

• 例 1: サブノード c が optional の場合(サブノード c とサブノード d の match パラメータの値は異なる必要がある)。

• 例 2: サブノード c とサブノード d の両方が optional の場合。

優先度

優先度は、ある区切り文字の他の区切り文字に対する優先順位を示します。デフォルトでは、すべての区切り文字の優先度は 10 で、つまり、すべての区切り文字は同様と見なされ、固定フィールドは優先度 10 でハードコードされます。親ノードの区切り文字は、子フィールドの解析時には考慮されず、子の区切り文字 (または子が固定フィールドの場合はその長さ) のみが考慮されます。

区切り文字の優先度を変更すると、入力データストリームに異なる方法で区切り文字が適用されるようになります。次に例を示します。

• ルートノード

  • 要素 (type delim, delimiter = “^”, repeat)

    • フィールド1 (type fixed, length = 5)

    • フィールド2 (type fixed, length = 8, optional)

  これは「abcde12345678^zyxvuABCDEFGH」を解析しますが、テキスト「abcde^zyxvuABCDEFGH」は、2 番目の固定フィールドが optional であっても解析されません。これは、要素と固定フィールドの区切り文字の優先度が同じであるため、要素の区切り文字が固定フィールド内で無視されるからです。固定フィールドデータ内で要素の区切り文字が調べられるようにするには、次のようにその優先度を変更します。

• ルートノード

  • 要素 (type delim, delimiter = “^”, repeat, precedence = 11)

    • フィールド1 (type fixed, length = 5)

    • フィールド2 (type fixed, length = 8, optional)

      この場合、テキスト「abcde^zyxvuABCDEFGH」は解析されます。

OTD セグメントの追加および編集

HL7 ライブラリ OTD は、HL7 メッセージセグメントに対応するさまざまな OTD で構成されています。メインの HL7 メッセージ OTD は、同じ HL7 ディレクトリ内にあるセグメント OTD への参照を含んでいます。

セグメントの編集

次の例では、HL7_25_ADT_A02 OTD を使用しています。OTD の特定セグメントのプロパティーを編集するには、次の手順に従います。

1. 編集する OTD セグメントを決定したら、プロジェクトエクスプローラの「Sun」 > 「OTD ライブラリ」 > 「HL7 フォルダ」からセグメント OTD をプロジェクトにコピー＆ペーストします。

2. エディタの「オブジェクト型定義」区画に示されているセグメント OTD の順序を書き留めておきます。元の OTD 構造を保つことが重要です。次の手順では、このリストからセグメント OTD を削除します。したがって、元のセグメント OTD の位置を書き留めておき、編集したセグメント OTD を OTD 構造内の元の位置に再配置できるようにすることが重要です (次の図を参照)。

   

3. 「参照」区画の「内部」タブで、SFT セグメントを右クリックし、「削除」を選択して、セグメントを削除します。

4. 「オブジェクト型定義」区画で、OTD ツリーから SFT セグメントを削除します。このためには、セグメントを右クリックし、ショートカットメニューから「削除」を選択します。

5. 「参照」区画の「外部」タブで、セグメント OTD の参照のうちどれかひとつを削除します。この操作によって、このセグメント OTD に対する他のすべての参照も削除されます。

6. セグメント OTD をメイン OTD にインポートするには、「OTD を外部テンプレートにインポート」アイコンをクリックします。「インポート」ダイアログボックスが表示されます。

7. 「インポート」ダイアログボックスで、プロジェクトファイルからインポートする OTD を検出して選択します。「追加」ボタンをクリックして、OTD を「インポートする OTD の選択」フィールドに追加します。「インポート」をクリックします (次の図を参照)。OTD がエディタの「参照」区画の「外部」タブに追加されます。

   

8. 「参照」区画の「外部」タブから、インポートしたセグメントの参照 (この例の場合、HL7_25_SFT/SFT) を「オブジェクト型定義」区画のルートノードにドラッグ＆ドロップします。セグメントがオブジェクト型定義ツリーに追加されます。

9. オブジェクト型定義ツリーで、セグメントを右クリックし、ショートカットメニューから「上のレベルへ」を選択して、セグメントをツリーの上位へ移動します。この手順を繰り返して、置き換え中のセグメントが存在していたのと同じ位置に新規セグメントが配置されるようにします。

10. 変更をリポジトリに保存します。

これで、プロジェクトに配置されたセグメント OTD を開き、そのプロパティーを編集できるようになりました。

メッセージ OTD へのセグメント OTD の追加

また、OTD の外部テンプレートにほかのセグメント OTD を追加することで、OTD を変更することもできます。

1. OTD とインポートするセグメント OTD をプロジェクトにコピーして保存します。OTD エディタで OTD を開きます。

2. OTD エディタのツールバーで、「OTD を外部テンプレートにインポート」アイコンをクリックします。「インポート」ダイアログボックスが表示されます。

3. 「インポート」ダイアログボックスで、プロジェクトファイルからインポートする OTD を検出して選択します。「追加」ボタンをクリックして、OTD を「インポートする OTD の選択」フィールドに追加します。「インポート」をクリックします。OTD がエディタの「参照」区画の「外部」タブに追加されます。

4. 「参照」区画の「外部」タブから、セグメント OTD 参照を「オブジェクト型定義」区画のルートノードにドラッグ＆ドロップします。セグメント OTD がオブジェクト型定義ツリーに追加されます。

5. 変更をリポジトリに保存します。

OTD プロパティー

OTD エディタの「オブジェクト型定義」区画 (中央の区画) には、OTD のノード、要素、およびフィールドが表示されます。これらのいずれかを選択すると、その項目のプロパティーが「プロパティー」区画に表示されます。

ノードのプロパティー

OTD エディタで HL7 OTD を開くと、ルートノードのプロパティーが「プロパティー」区画に表示されます。設定できるノードのプロパティーを次の表に示します。

javaName プロパティーは変更しないでください。

要素のプロパティー

次の図に、要素レベルに関連付けられた一連のプロパティーを示します。

図 1–14 OTD エディタ - OTD 要素のプロパティー

設定できる要素のプロパティーを次の表に示します。

javaName プロパティーは変更しないでください。

フィールドのプロパティー

次の図に、フィールドレベルに関連付けられた一連のプロパティーを示します。

図 1–15 OTD エディタ - OTD フィールドのプロパティー

設定できるフィールドのプロパティーを次の表に示します。

javaName プロパティーは変更しないでください。

ノードタイプの指定

nodeType プロパティーフィールドをクリックすると、フィールドが編集できるようになります。矢印ボタンをクリックすると、選択メニューが表示されます。プロパティーオプションの説明を次の表に示します。

OTD ノードを移動した場合は、そのノードの nodeType をリセットします。

ノードの管理

OTD エディタでは、次の操作が可能です。

• ノードおよび要素を OTD に「追加」する。

• OTD からノードおよび要素を「削除」する。

  ノードが削除されると、ノードと、このノードに関連付けられていた子 (データ要素) の両方が削除されます。

• OTD 内のノードを「取り除く」。

  ノードが取り除かれると、このノードに関連付けられていた子 (データ要素) のみが削除され、ノード自体は維持されます。取り除きは、ノードに対してのみ実行できます。

これらのコマンドには、ノードのコンテキストメニューからアクセスします。