HL7 FHIR JP Core ImplementationGuide
1.1.2 - release Japan flag

HL7 FHIR JP Core ImplementationGuide - Local Development build (v1.1.2) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: JP Core Location Profile

項目内容
定義URL http://jpfhir.jp/fhir/core/StructureDefinition/JP_Location
Version 1.1.2
Name

JP_Location
Title

JP Core Location Profile
Status Active ( 2023-10-31 )
Copyright

Copyright FHIR Japanese implementation research working group in Japan Association of Medical Informatics (JAMI) 一般社団法人日本医療情報学会NeXEHRS課題研究会FHIR日本実装検討WG

このプロファイルはLocationリソースに対して、所在場所のデータを送受信するための基礎となる制約と拡張を定めたものである。


本プロファイルは、患者、プロバイダ、または組織に関連付けられたロケーションを記録、検索、およびフェッチするために 、FHIR Location リソースを使用するにあたっての、最低限の制約を記述したものである。Location リソースに対して本プロファイルに準拠する場合に必須となる要素や、サポートすべき拡張、用語、検索パラメータを定義する。

背景および想定シナリオ

本プロファイルは、以下のようなユースケースを想定している。

  • 所在場所名または所在場所の住所による所在場所の検索

  • 他のリソースからの所在場所の参照（例：Encounterリソースのhospitalizationで参照される患者の入院前や退院後の所在場所）

スコープ

所在場所には、偶発的な場所（事前の指定や許可なしに医療に使用される場所）と、正式に指定された専用の場所の両方が含まれる。場所は、プライベート、パブリック、モバイル、または固定であり、小さな冷凍庫から完全な病院の建物または駐車場までの規模になる。本リソースに含まれる所在場所の例を示す（ただし、この一覧に限定されない）。

  • 建物、病棟、廊下、部屋またはベッド
  • モバイルクリニック
  • 冷凍庫、インキュベーター
  • 車両またはリフト
  • 家、小屋、またはガレージ
  • 道路、駐車場、公園
  • 救急車（ジェネリック）
  • 救急車（特定）
  • 患者の家（一般）
  • 管轄

これらの所在場所は、何かが発生した患者の所在場所（骨折した部位、例えば足）をカバーすることを目的としていないが、患者が足を骨折した場所（例えば、遊び場）をカバーできる。

プロファイル定義

Usage:

プロファイル詳細

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*Location物理的な場所の詳細情報と位置情報
... identifier 0..*Identifierユーザに場所を特定する一意のコードまたは番号
... status 0..1codeactive | suspended | inactive / アクティブ|中断|非アクティブ
... operationalStatus 0..1Codingロケーションの運用ステータス（通常、ベッド/部屋のみ）
... name 0..1string人間が使用する場所の名前
... alias 0..*stringその場所が過去に知られていた、または以前から知られていた別名のリスト
... description 0..1string名前以外の場所を識別するための詳細情報として表示できる場所に関する追加の詳細
... mode 0..1codeinstance | kind / インスタンス|種類
... type 0..*CodeableConcept実行される機能のタイプ
... telecom 0..*ContactPoint所在地の連絡先
... address 0..1Address物理的な場所
... physicalType 0..1CodeableConcept場所の物理的な形態
... position 0..1BackboneElement絶対的な地理的位置
.... longitude 1..1decimalWGS84データの経度
.... latitude 1..1decimalWGS84データの緯度
.... altitude 0..1decimalWGS84データによる高度
... managingOrganization 0..1Reference(JP Core Organization Profile)プロビジョニングと維持管理を担当する組織
... partOf 0..1Reference(JP Core Location Profile)この場所が物理的に存在するもう一つの場所
... hoursOfOperation 0..*BackboneElementこの場所は通常、1週間のうち何日/時間帯に営業している
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun / 月｜火｜水｜木｜金｜土｜日
.... allDay 0..1booleanその場所は終日営業している
.... openingTime 0..1time場所が開く時間
.... closingTime 0..1time場所が閉まる時間
... availabilityExceptions 0..1string利用可能の例外についての説明
... endpoint 0..*Reference(Endpoint)場所のために運営されているサービスへのアクセスを提供する技術的なエンドポイント

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*Location物理的な場所の詳細情報と位置情報
... id Σ0..1idこのアーティファクトの論理ID
... meta Σ0..1Metaリソースに関するメタデータ
... implicitRules ?!Σ0..1uriこのコンテンツが作成されたルールセット
... language 0..1code「リソースコンテンツの言語」
Binding: CommonLanguages (preferred): 「人間の言語。」

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1Narrative人間の解釈のためのリソースのテキスト要約
... contained 0..*Resource「含まれている、インラインのリソース」
... extension 0..*Extension実装によって定義される追加コンテンツ
... modifierExtension ?!0..*Extension無視できない拡張機能 (Mushi dekinai kakuchou kinou)
... identifier Σ0..*Identifierユーザに場所を特定する一意のコードまたは番号
... status ?!Σ0..1codeactive | suspended | inactive / アクティブ|中断|非アクティブ
Binding: LocationStatus (required): 「場所がまだ使用されているかどうかを示します。」

... operationalStatus Σ0..1Codingロケーションの運用ステータス（通常、ベッド/部屋のみ）
Binding: hl7VS-bedStatus (preferred): 通常ベッド/部屋が位置する場所の稼働状況

... name Σ0..1string人間が使用する場所の名前
... alias 0..*stringその場所が過去に知られていた、または以前から知られていた別名のリスト
... description Σ0..1string名前以外の場所を識別するための詳細情報として表示できる場所に関する追加の詳細
... mode Σ0..1codeinstance | kind / インスタンス|種類
Binding: LocationMode (required): リソースインスタンスが特定の場所を表すのか、場所のクラスを表すのかを示します。

... type Σ0..*CodeableConcept実行される機能のタイプ
Binding: ServiceDeliveryLocationRoleType (extensible): 「場所で行われる機能のタイプを示します。」


... telecom 0..*ContactPoint所在地の連絡先
... address 0..1Address物理的な場所
... physicalType Σ0..1CodeableConcept場所の物理的な形態
Binding: LocationType (example): 場所の実体形態。

... position 0..1BackboneElement絶対的な地理的位置
.... id 0..1stringエレメント相互参照のためのユニークID
.... extension 0..*Extension実装によって定義される追加コンテンツ
.... modifierExtension ?!Σ0..*Extension認識されなくても無視できない拡張機能
.... longitude 1..1decimalWGS84データの経度
.... latitude 1..1decimalWGS84データの緯度
.... altitude 0..1decimalWGS84データによる高度
... managingOrganization Σ0..1Reference(JP Core Organization Profile)プロビジョニングと維持管理を担当する組織
... partOf 0..1Reference(JP Core Location Profile)この場所が物理的に存在するもう一つの場所
... hoursOfOperation 0..*BackboneElementこの場所は通常、1週間のうち何日/時間帯に営業している
.... id 0..1stringエレメント相互参照のためのユニークID
.... extension 0..*Extension実装によって定義される追加コンテンツ
.... modifierExtension ?!Σ0..*Extension認識されなくても無視できない拡張機能
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun / 月｜火｜水｜木｜金｜土｜日
Binding: DaysOfWeek (required): 曜日 (Youbi)


.... allDay 0..1booleanその場所は終日営業している
.... openingTime 0..1time場所が開く時間
.... closingTime 0..1time場所が閉まる時間
... availabilityExceptions 0..1string利用可能の例外についての説明
... endpoint 0..*Reference(Endpoint)場所のために運営されているサービスへのアクセスを提供する技術的なエンドポイント

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.operationalStatuspreferredHl7VSBedStatus
http://terminology.hl7.org/ValueSet/v2-0116
Location.moderequiredLocationMode
http://hl7.org/fhir/ValueSet/location-mode|4.0.1
from the FHIR Standard
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLocationもしリソースが他のリソースに含まれている場合、そのリソースにはネストされたリソースを含めてはなりません (moshi risōsu ga hoka no risōsu ni fukumarete iru baai, sono risōsu ni wa nesuto sareta risōsu o fukumete wa narimasen).
: contained.contained.empty()
dom-3errorLocationもしリソースが他のリソースに含まれている場合、それはリソースの他の場所から参照されるか、含まれるリソースに参照されるべきです。
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorLocationもしリソースが別のリソースの中に含まれる場合、meta.versionIdまたはmeta.lastUpdatedを持つべきではありません。
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorLocationもしリソースが他のリソースに含まれている場合、セキュリティラベルを持つべきではありません。
: contained.meta.security.empty()
dom-6best practiceLocation資源は堅牢な管理のために物語を持つべきである。
: text.`div`.exists()
ele-1error**ALL** elementsすべてのFHIR要素は、@valueまたはchildrenを持っている必要があります。
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensions拡張機能または値[x]のいずれかが必要です。両方ではありません。
: extension.exists() != value.exists()

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*Location物理的な場所の詳細情報と位置情報
... identifier 0..*Identifierユーザに場所を特定する一意のコードまたは番号
... status 0..1codeactive | suspended | inactive / アクティブ|中断|非アクティブ
... operationalStatus 0..1Codingロケーションの運用ステータス（通常、ベッド/部屋のみ）
... name 0..1string人間が使用する場所の名前
... alias 0..*stringその場所が過去に知られていた、または以前から知られていた別名のリスト
... description 0..1string名前以外の場所を識別するための詳細情報として表示できる場所に関する追加の詳細
... mode 0..1codeinstance | kind / インスタンス|種類
... type 0..*CodeableConcept実行される機能のタイプ
... telecom 0..*ContactPoint所在地の連絡先
... address 0..1Address物理的な場所
... physicalType 0..1CodeableConcept場所の物理的な形態
... position 0..1BackboneElement絶対的な地理的位置
.... longitude 1..1decimalWGS84データの経度
.... latitude 1..1decimalWGS84データの緯度
.... altitude 0..1decimalWGS84データによる高度
... managingOrganization 0..1Reference(JP Core Organization Profile)プロビジョニングと維持管理を担当する組織
... partOf 0..1Reference(JP Core Location Profile)この場所が物理的に存在するもう一つの場所
... hoursOfOperation 0..*BackboneElementこの場所は通常、1週間のうち何日/時間帯に営業している
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun / 月｜火｜水｜木｜金｜土｜日
.... allDay 0..1booleanその場所は終日営業している
.... openingTime 0..1time場所が開く時間
.... closingTime 0..1time場所が閉まる時間
... availabilityExceptions 0..1string利用可能の例外についての説明
... endpoint 0..*Reference(Endpoint)場所のために運営されているサービスへのアクセスを提供する技術的なエンドポイント

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*Location物理的な場所の詳細情報と位置情報
... id Σ0..1idこのアーティファクトの論理ID
... meta Σ0..1Metaリソースに関するメタデータ
... implicitRules ?!Σ0..1uriこのコンテンツが作成されたルールセット
... language 0..1code「リソースコンテンツの言語」
Binding: CommonLanguages (preferred): 「人間の言語。」

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1Narrative人間の解釈のためのリソースのテキスト要約
... contained 0..*Resource「含まれている、インラインのリソース」
... extension 0..*Extension実装によって定義される追加コンテンツ
... modifierExtension ?!0..*Extension無視できない拡張機能 (Mushi dekinai kakuchou kinou)
... identifier Σ0..*Identifierユーザに場所を特定する一意のコードまたは番号
... status ?!Σ0..1codeactive | suspended | inactive / アクティブ|中断|非アクティブ
Binding: LocationStatus (required): 「場所がまだ使用されているかどうかを示します。」

... operationalStatus Σ0..1Codingロケーションの運用ステータス（通常、ベッド/部屋のみ）
Binding: hl7VS-bedStatus (preferred): 通常ベッド/部屋が位置する場所の稼働状況

... name Σ0..1string人間が使用する場所の名前
... alias 0..*stringその場所が過去に知られていた、または以前から知られていた別名のリスト
... description Σ0..1string名前以外の場所を識別するための詳細情報として表示できる場所に関する追加の詳細
... mode Σ0..1codeinstance | kind / インスタンス|種類
Binding: LocationMode (required): リソースインスタンスが特定の場所を表すのか、場所のクラスを表すのかを示します。

... type Σ0..*CodeableConcept実行される機能のタイプ
Binding: ServiceDeliveryLocationRoleType (extensible): 「場所で行われる機能のタイプを示します。」


... telecom 0..*ContactPoint所在地の連絡先
... address 0..1Address物理的な場所
... physicalType Σ0..1CodeableConcept場所の物理的な形態
Binding: LocationType (example): 場所の実体形態。

... position 0..1BackboneElement絶対的な地理的位置
.... id 0..1stringエレメント相互参照のためのユニークID
.... extension 0..*Extension実装によって定義される追加コンテンツ
.... modifierExtension ?!Σ0..*Extension認識されなくても無視できない拡張機能
.... longitude 1..1decimalWGS84データの経度
.... latitude 1..1decimalWGS84データの緯度
.... altitude 0..1decimalWGS84データによる高度
... managingOrganization Σ0..1Reference(JP Core Organization Profile)プロビジョニングと維持管理を担当する組織
... partOf 0..1Reference(JP Core Location Profile)この場所が物理的に存在するもう一つの場所
... hoursOfOperation 0..*BackboneElementこの場所は通常、1週間のうち何日/時間帯に営業している
.... id 0..1stringエレメント相互参照のためのユニークID
.... extension 0..*Extension実装によって定義される追加コンテンツ
.... modifierExtension ?!Σ0..*Extension認識されなくても無視できない拡張機能
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun / 月｜火｜水｜木｜金｜土｜日
Binding: DaysOfWeek (required): 曜日 (Youbi)


.... allDay 0..1booleanその場所は終日営業している
.... openingTime 0..1time場所が開く時間
.... closingTime 0..1time場所が閉まる時間
... availabilityExceptions 0..1string利用可能の例外についての説明
... endpoint 0..*Reference(Endpoint)場所のために運営されているサービスへのアクセスを提供する技術的なエンドポイント

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.operationalStatuspreferredHl7VSBedStatus
http://terminology.hl7.org/ValueSet/v2-0116
Location.moderequiredLocationMode
http://hl7.org/fhir/ValueSet/location-mode|4.0.1
from the FHIR Standard
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLocationもしリソースが他のリソースに含まれている場合、そのリソースにはネストされたリソースを含めてはなりません (moshi risōsu ga hoka no risōsu ni fukumarete iru baai, sono risōsu ni wa nesuto sareta risōsu o fukumete wa narimasen).
: contained.contained.empty()
dom-3errorLocationもしリソースが他のリソースに含まれている場合、それはリソースの他の場所から参照されるか、含まれるリソースに参照されるべきです。
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorLocationもしリソースが別のリソースの中に含まれる場合、meta.versionIdまたはmeta.lastUpdatedを持つべきではありません。
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorLocationもしリソースが他のリソースに含まれている場合、セキュリティラベルを持つべきではありません。
: contained.meta.security.empty()
dom-6best practiceLocation資源は堅牢な管理のために物語を持つべきである。
: text.`div`.exists()
ele-1error**ALL** elementsすべてのFHIR要素は、@valueまたはchildrenを持っている必要があります。
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensions拡張機能または値[x]のいずれかが必要です。両方ではありません。
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron

必須要素

本プロファイルで定義された必須項目はない。

Extensions定義

本プロファイルで追加定義された拡張はない。

利用方法

OperationおよびSearch Parameter 一覧

Search Parameter一覧

コンフォーマンス パラメータ 型 例
SHALL name string GET [base]/Location?name=３南
SHALL identifier token GET [base]/Location?identifier=http://myhospital.com/fhir/Locationid|1234
SHOULD address string GET [base]/Location?address=東京都文京区本郷７丁目３−１
SHOULD address-city string GET [base]/Location?address-city=文京区
SHOULD address-state string GET [base]/Location?address-state=東京都
SHOULD address-postalcode string GET [base]/Location?address-postalcode=1130033
必須検索パラメータ

次の検索パラメータは必須でサポートされなければならない。

  1. name 検索パラメータを使用して、任意の名前パートによる文字列検索をサポートしなければならない（SHALL）

    GET [base]/Location?name={string}

    例：

    GET [base]/Location?name=３南

    名前が一致するLocationリソースを含むBundleを取得する。

  2. identifier 検索パラメータを使用して、ロケーションIDなどの識別子によるLocationの検索をサポートしなければならない（SHALL）

    GET [base]/Location?identifier={system|}[code]

    例：

    GET [base]/Location?identifier=http://myhospital.com/fhir/Locationid|1234

    指定された識別子に一致するLocationリソースを含むBundleを取得する。

推奨検索パラメータ

次の検索パラメータをサポートすることが望ましい。

  1. address 検索パラメータを使用して、住所テキストによる文字列検索をサポートすることが望ましい（SHOULD）

    GET [base]/Location?address={string}

    例：

    GET [base]/Location?address=東京都文京区本郷７丁目３−１

    住所文字列が一致するLocationリソースを含むBundleを取得する。

  2. address-city 検索パラメータを使用して、住所の市町村名によるLocationの検索をサポートすることが望ましい（SHOULD）

    GET [base]/Location?address-city={string}

    例：

    GET [base]/Location?address-city=文京区

    指定された住所の市町村名が一致するLocationリソースを含むBundleを取得する。

  3. address-state 検索パラメータを使用して、住所の都道府県名によるLocationの検索をサポートすることが望ましい（SHOULD）

    GET [base]/Location?address-state={string}

    例：

    GET [base]/Location?address-state=東京都

    指定された住所の都道府県名が一致するLocationリソースを含むBundleを取得する。

  4. address-postalcode 検索パラメータを使用して、住所の郵便番号によるLocationの検索をサポートすることが望ましい（SHOULD）

    GET [base]/Location?address-postalcode={string}

    例：

    GET [base]/Location?address-postalcode=1130033

    指定された住所の郵便番号が一致するLocationリソースを含むBundleを取得する。

追加検索パラメータ

追加検索パラメータは定義しない。

サンプル

その他、参考文献・リンク等

  1. 退院時サマリー規約 http://www.hl7.jp/library/item/HL7J-CDA-007.pdf
  2. 診療情報提供書規格 http://www.hl7.jp/intro/std/HL7J-CDA-005.pdf
  3. 特定健診情報ファイル仕様 https://www.mhlw.go.jp/stf/seisakunitsuite/bunya/0000165280.html
  4. SS-MIX2 標準化ストレージ 仕様書 Ver.1.2h https://www.jami.jp/jamistd/docs/SS-MIX2/h/SS-MIX2_StndrdStrgSpecVer.1.2h.pdf
  5. ICSR E2B(R3) https://www.pmda.go.jp/int-activities/int-harmony/ich/0093.html