ぴっどりんく HL7FHIR R4 ファサードAPI サーバ実装ガイド

このドキュメントは、 ぴっどりんくHL7FHIR R4 ファサードAPI の実装ガイドです。この実装ガイドは、株式会社SBS情報システムにより作成されたドラフト版の仕様です。ドキュメントの内容は今後、予告なく内容に変更される場合があります。

1.1. 概要

この実装ガイドは、HL7®FHIR®標準 の v4.0.1: R4 を元にぴっどりんくが管理する患者データにアクセスするための ファサード型API である ぴっどりんく HL7FHIR R4 ファサードAPI の最小限の適合性要件を定めたものです。

ぴっどりんくは、複数の医療機関などにおける同一患者の異なる患者IDをひもづけるシステムです。各施設で個別に管理されている患者IDを自動的に相互突合し、同一患者の識別を可能とするデータの管理を行います。

ぴっどりんく HL7FHIR R4 ファサードAPI は、ぴっどりんくが管理する患者ひもづけデータを利用したり、ぴっどりんくに対し患者情報を提供するために外部システムがR4のインタラクションでアクセスするための ファサードAPI（Facade API）です。PIDLinkが管理するデータへのアクセス手順をFHIRインタラクションに置き換えることにより、アクセス手順を簡略化することを目的としています。このサーバはFHIRインタラクションでクライアントの要求を受信すると、バックグラウンドで管理対象のPIDLinkAPIに対し要求を行い、その応答をR4形式に変換し返却します。そのため、サーバが機能するためにはあらかじめPIDLinkAPIが動作可能な環境を構築しなければなりません。

ぴっどりんく HL7FHIR R4 ファサードAPI は、PIDLinkAPIの機能を使用するため、検索パラメータの機能などに一部の制限があります。詳細は「1.3. Capability Statement （機能宣言）」をご確認ください。

1.2. コンテンツ

1.2.1. Profile

• Profiles for PidLinkEverything

  • ぴっどりんく患者ひもづけ情報バンドル

  • ぴっどりんく患者ひもづけ情報

  これらのプロファイルは後述の PidLinkEverything オペレーションで用いるためのものです。通常のFHIRインタラクション使用するプロファイルは「1.3. Capability Statement （機能宣言）」をご確認ください。

1.2.2. Operation

• PidLinkEverything

  このオペレーションは統合患者IDによってひもづけられた１つまたは複数の施設内患者IDを要求するために使用します。このオペレーションは応答として"searchset"バンドルを返却します。バンドルにエントリーされるPatientリソースはぴっどりんくの日次処理で作成されるもので、FHIRリポジトリでは管理されていない一時的なデータです。このオペレーションで取得可能なデータは前日までにぴっどりんくでひもづけが行われたデータであり、定期処理での取得を想定しています。オペレーションを実行した当日に作成されたデータは取得の対象外です。データ取得前日より前にひもづけが行われたデータが取得できるかは保証されません。そのため、クライアントは日次処理などで定期的にデータを取り込む必要があります。

  Invocations

  URL: [base]/$pidlink-everything
  

  This operation does NOT change content

  Parameters (In)

  Name	Cardinality	Type	Documentation
  date	1..1	date	この日にひもづけが行われた統合患者IDとそれにひもづく一連の施設内患者IDが戻り値に含まれます。未指定の場合、サーバは"400 Bad Request"を返却します。
  pagesno	0..1	integer	0から始まるページ番号を指定します。Bundle-searchset.link(relation="next")に次のページのURLが設定されます。次のページが存在しない場合はBundle-searchset.link(relation="next")は設定されません。未指定の場合は0として扱います。

  Return Values (Out)

  Name	Cardinality	Type	Documentation
  return	0..1	Bundle	"searchset"バンドルを返却します。バンドルにはPatientリソース（PidLinkPatientプロファイル）がエントリーされます。デフォルトのバンドルのエントリー最大数は1,000です。最大数を超える場合はBundle-searchset.link(relation="next")に設定されたURLから次のデータを取得します。

1.2.3. Messaging

$process-messageオペレーションで使用するMessage Bundleを定義します。

1.2.3.1 患者情報登録

外部システム、特に患者情報および保険情報の発生源（医事システムなど）がそれらの登録や更新をぴっどりんくに通知するために使用するメッセージ定義です。

• MessageDefinition

1.3. Capability Statement （機能宣言）

• PIDLinkAdapterR4Requirements

  この CapabilityStatement は、ぴっどりんく HL7FHIR R4 ファサードAPI が最小限実装すべきシステム機能を定義します。

  REST Capabilities Server

  Mode	Server
  Documentation	PIDLinkのFHIRエンドポイントです。

  Resource Interactions

  Resource Type	Profile	Supported Profiles	Read	SearchType
  MessageDefinition	MessageDefinition		✓
  Organization	Organization		✓	✓
  Patient	Patient		✓	✓

  Global Operations

  Operation	Reference	Level
  everything	Fetch Patient Record	Supported
  process-message	Process Message	Supported
  pidlink-everything	PidLinkEverything	Supported

  Search Parameters per resource type

  MessageDefinition

  No search parameters are stated for this resource type

  Organization

  Name	Type	Documentation	Level
  _id	token	Organization.id（保健医療機関コード）を指定します。	Supported

  Patient

  Name	Type	Documentation	Level
  _id	token	Patient.id を指定します。"[施設内患者ID].[保健医療機関コード（Organization.id）]" の形式です。PIDLinkAPIの制限で統合患者IDを指定した場合、サーバは"400 Bad Request"を返却します。統合患者IDで検索を行う場合はidentifierを使用します。	Supported
  birthDate	date	生年月日を指定します。等しい値（birthData=yyyy-MM-dd）のみ検索対象です。	Supported
  address	string	住所を指定します。住所テキストのみ検索対象です。PIDLinkAPIと同様の検索を行います。	Supported
  address-postalcode	string	郵便番号を指定します。PIDLinkAPIと同様の検索を行います。	Supported
  family	string	姓を指定します。カナ氏名のみ検索対象です。漢字氏名を検索する場合は ["IDE|漢字姓"] を指定します。PIDLinkAPIと同様の検索を行います。	Supported
  given	string	名を指定します。カナ氏名のみ検索対象です。漢字氏名を検索する場合は ["IDE|漢字名"] を指定します。PIDLinkAPIと同様の検索を行います。	Supported
  gender	string	性別（male | female | other | unknown）を指定します。	Supported
  identifier	token	識別子を指定します。統合患者IDを指定した場合はシステム上の制約により、[identifier] 以外の検索パラメータは無効になります。Identifier.systemを指定しない場合は施設内患者IDとみなし検索した後、結果が存在しないのであれば統合患者IDとみなし検索します。	Supported
  link	string	Patient.idを指定します。検索結果ではPatient.idにひもづいたPatientリソースの一覧を取得します。このパラメータを指定した場合、PIDLinkAPIの制約により [link] [organization] 以外の検索パラメータ（ページング含む）は無効になります。	Supported
  organization	reference	Organization.id（保健医療機関コード）を指定します。	Supported
  phone	string	電話番号を指定します。用途（自宅、携帯番号など）の区別はできません。PIDLinkAPIと同様の検索を行います。	Supported

  Messaging Capabilities

  Protocol	Address

  Documentation

  患者情報と保健情報の登録・更新をPIDLinkAPIに要求します。

  Mode	Supported Message
  Receiver	MessageDefinition/pidlink-patient-register

1.4. Seculity

• ぴっどりんく HL7FHIR R4 ファサードAPI は、オンプレミスでのみ使用を想定しています。

• ぴっどりんくを使用するプロジェクトに応じた適正なセキュリティ要件を定め、それに従う必要があります。

Presented by SBS Information System Co.,Ltd.