HL7 FHIR JP Core ImplementationGuide
1.1.1 - ci-build
HL7 FHIR JP Core ImplementationGuide
1.1.1 - ci-build
HL7 FHIR JP Core ImplementationGuide - Local Development build (v1.1.1). See the Directory of published versions
| 項目 | 内容 |
| 定義URL | http://jpfhir.jp/fhir/core/StructureDefinition/JP_Location |
| Version | 1.1.1 |
| Name | JP_Location |
| Title | JP Core Location Profile |
| Status | Active ( 2022-10-24 ) |
| 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.
This structure is derived from Location
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Location | 0..* | Location | 物理的な場所の詳細情報と位置情報 | |
  identifier | 0..* | Identifier | Unique code or number identifying the location to its users / ユーザに場所を特定する一意のコードまたは番号 | |
| status | 0..1 | code | active | suspended | inactive / アクティブ|中断|非アクティブ | |
| operationalStatus | 0..1 | Coding | The operational status of the location (typically only for a bed/room) / ロケーションの運用ステータス（通常、ベッド/部屋のみ） | |
| name | 0..1 | string | Name of the location as used by humans / 人間が使用する場所の名前 | |
| alias | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past / その場所が過去に知られていた、または以前から知られていた別名のリスト | |
| description | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name / 名前以外の場所を識別するための詳細情報として表示できる場所に関する追加の詳細 | |
| mode | 0..1 | code | instance | kind / インスタンス|種類 | |
| type | 0..* | CodeableConcept | Type of function performed / 実行される機能のタイプ | |
| telecom | 0..* | ContactPoint | Contact details of the location / 所在地の連絡先 | |
| address | 0..1 | Address | Physical location / 物理的な場所 | |
| physicalType | 0..1 | CodeableConcept | Physical form of the location / 場所の物理的な形態 | |
| position | 0..1 | BackboneElement | The absolute geographic location / 絶対的な地理的位置 | |
 longitude | 1..1 | decimal | Longitude with WGS84 datum / WGS84データの経度 | |
| latitude | 1..1 | decimal | Latitude with WGS84 datum / WGS84データの緯度 | |
 altitude | 0..1 | decimal | Altitude with WGS84 datum / WGS84データによる高度 | |
 managingOrganization | 0..1 | Reference(JP Core Organization Profile) | Organization responsible for provisioning and upkeep / プロビジョニングと維持管理を担当する組織 | |
| partOf | 0..1 | Reference(JP Core Location Profile) | Another Location this one is physically a part of / この場所が物理的に存在するもう一つの場所 | |
| hoursOfOperation | 0..* | BackboneElement | What days/times during a week is this location usually open / この場所は通常、1週間のうち何日/時間帯に営業している | |
| daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun / 月｜火｜水｜木｜金｜土｜日 | |
| allDay | 0..1 | boolean | The Location is open all day / その場所は終日営業している | |
| openingTime | 0..1 | time | Time that the Location opens / 場所が開く時間 | |
| closingTime | 0..1 | time | Time that the Location closes / 場所が閉まる時間 | |
| availabilityExceptions | 0..1 | string | Description of availability exceptions / 利用可能の例外についての説明 | |
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location / 場所のために運営されているサービスへのアクセスを提供する技術的なエンドポイント | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Location | 0..* | Location | 物理的な場所の詳細情報と位置情報 | |||||
 id | Σ | 0..1 | id | このアーティファクトの論理ID | ||||
 meta | Σ | 0..1 | Meta | 「リソースに関するメタデータ」 | ||||
| implicitRules | ?!Σ | 0..1 | uri | このコンテンツが作成されたルールセット | ||||
| language | 0..1 | code | 「リソースコンテンツの言語」(Risōsukontentsu no gengo) Binding: CommonLanguages (preferred): 「人間の言語。」(Ningen no gengo.)
| |||||
| text | 0..1 | Narrative | 「人間の解釈のためのリソースのテキスト要約」 | |||||
| contained | 0..* | Resource | 「含まれている、インラインのリソース」(Fukuma rete iru, inrain no risōsu) | |||||
 extension | 0..* | Extension | 実装によって定義される追加コンテンツ | |||||
 modifierExtension | ?! | 0..* | Extension | 無視できない拡張機能 (Mushi dekinai kakuchou kinou) | ||||
| identifier | Σ | 0..* | Identifier | Unique code or number identifying the location to its users / ユーザに場所を特定する一意のコードまたは番号 | ||||
| status | ?!Σ | 0..1 | code | active | suspended | inactive / アクティブ|中断|非アクティブ Binding: LocationStatus (required): 「場所がまだ使用されているかどうかを示します。」(Basho ga mada shiyou sarete iru ka dou ka wo shimeshimasu.) | ||||
| operationalStatus | Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) / ロケーションの運用ステータス（通常、ベッド/部屋のみ） Binding: hl7VS-bedStatus (preferred): 「通常ベッド/部屋が位置する場所の稼働状況」 | ||||
| name | Σ | 0..1 | string | Name of the location as used by humans / 人間が使用する場所の名前 | ||||
| alias | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past / その場所が過去に知られていた、または以前から知られていた別名のリスト | |||||
| description | Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name / 名前以外の場所を識別するための詳細情報として表示できる場所に関する追加の詳細 | ||||
| mode | Σ | 0..1 | code | instance | kind / インスタンス|種類 Binding: LocationMode (required): 「リソースインスタンスが特定の場所を表すのか、場所のクラスを表すのかを示します。」 | ||||
| type | Σ | 0..* | CodeableConcept | Type of function performed / 実行される機能のタイプ Binding: ServiceDeliveryLocationRoleType (extensible): 「場所で行われる機能のタイプを示します。」(Basho de okonawareru kinou no taipu wo shimesu.) | ||||
| telecom | 0..* | ContactPoint | Contact details of the location / 所在地の連絡先 | |||||
| address | 0..1 | Address | Physical location / 物理的な場所 | |||||
| physicalType | Σ | 0..1 | CodeableConcept | Physical form of the location / 場所の物理的な形態 Binding: LocationType (example): 場所の実体形態。 | ||||
| position | 0..1 | BackboneElement | The absolute geographic location / 絶対的な地理的位置 | |||||
| id | 0..1 | string | エレメント相互参照のためのユニークID | |||||
| extension | 0..* | Extension | 実装によって定義される追加コンテンツ | |||||
| modifierExtension | ?!Σ | 0..* | Extension | 「認識されなくても無視できない拡張機能」(Ninshiki sarenakutemo mushi dekinai kakuchou kinou) | ||||
| longitude | 1..1 | decimal | Longitude with WGS84 datum / WGS84データの経度 | |||||
| latitude | 1..1 | decimal | Latitude with WGS84 datum / WGS84データの緯度 | |||||
| altitude | 0..1 | decimal | Altitude with WGS84 datum / WGS84データによる高度 | |||||
| managingOrganization | Σ | 0..1 | Reference(JP Core Organization Profile) | Organization responsible for provisioning and upkeep / プロビジョニングと維持管理を担当する組織 | ||||
| partOf | 0..1 | Reference(JP Core Location Profile) | Another Location this one is physically a part of / この場所が物理的に存在するもう一つの場所 | |||||
| hoursOfOperation | 0..* | BackboneElement | What days/times during a week is this location usually open / この場所は通常、1週間のうち何日/時間帯に営業している | |||||
| id | 0..1 | string | エレメント相互参照のためのユニークID | |||||
| extension | 0..* | Extension | 実装によって定義される追加コンテンツ | |||||
| modifierExtension | ?!Σ | 0..* | Extension | 「認識されなくても無視できない拡張機能」(Ninshiki sarenakutemo mushi dekinai kakuchou kinou) | ||||
| daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun / 月｜火｜水｜木｜金｜土｜日 Binding: DaysOfWeek (required): 曜日 (Youbi) | |||||
| allDay | 0..1 | boolean | The Location is open all day / その場所は終日営業している | |||||
| openingTime | 0..1 | time | Time that the Location opens / 場所が開く時間 | |||||
| closingTime | 0..1 | time | Time that the Location closes / 場所が閉まる時間 | |||||
| availabilityExceptions | 0..1 | string | Description of availability exceptions / 利用可能の例外についての説明 | |||||
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location / 場所のために運営されているサービスへのアクセスを提供する技術的なエンドポイント | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Location.language | preferred | CommonLanguages
| ||||
| Location.status | required | LocationStatus | ||||
| Location.operationalStatus | preferred | Hl7VSBedStatus | ||||
| Location.mode | required | LocationMode | ||||
| Location.type | extensible | ServiceDeliveryLocationRoleType | ||||
| Location.physicalType | example | LocationType | ||||
| Location.hoursOfOperation.daysOfWeek | required | DaysOfWeek |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | すべてのFHIR要素は、@valueまたはchildrenを持っている必要があります。 : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | 「拡張機能または値[x]のいずれかが必要です。両方ではありません。」 : extension.exists() != value.exists() |
This structure is derived from Location
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | 0..* | Location | 物理的な場所の詳細情報と位置情報 | |
| identifier | 0..* | Identifier | Unique code or number identifying the location to its users / ユーザに場所を特定する一意のコードまたは番号 | |
| status | 0..1 | code | active | suspended | inactive / アクティブ|中断|非アクティブ | |
| operationalStatus | 0..1 | Coding | The operational status of the location (typically only for a bed/room) / ロケーションの運用ステータス（通常、ベッド/部屋のみ） | |
| name | 0..1 | string | Name of the location as used by humans / 人間が使用する場所の名前 | |
| alias | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past / その場所が過去に知られていた、または以前から知られていた別名のリスト | |
| description | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name / 名前以外の場所を識別するための詳細情報として表示できる場所に関する追加の詳細 | |
| mode | 0..1 | code | instance | kind / インスタンス|種類 | |
| type | 0..* | CodeableConcept | Type of function performed / 実行される機能のタイプ | |
| telecom | 0..* | ContactPoint | Contact details of the location / 所在地の連絡先 | |
| address | 0..1 | Address | Physical location / 物理的な場所 | |
| physicalType | 0..1 | CodeableConcept | Physical form of the location / 場所の物理的な形態 | |
| position | 0..1 | BackboneElement | The absolute geographic location / 絶対的な地理的位置 | |
| longitude | 1..1 | decimal | Longitude with WGS84 datum / WGS84データの経度 | |
| latitude | 1..1 | decimal | Latitude with WGS84 datum / WGS84データの緯度 | |
| altitude | 0..1 | decimal | Altitude with WGS84 datum / WGS84データによる高度 | |
| managingOrganization | 0..1 | Reference(JP Core Organization Profile) | Organization responsible for provisioning and upkeep / プロビジョニングと維持管理を担当する組織 | |
| partOf | 0..1 | Reference(JP Core Location Profile) | Another Location this one is physically a part of / この場所が物理的に存在するもう一つの場所 | |
| hoursOfOperation | 0..* | BackboneElement | What days/times during a week is this location usually open / この場所は通常、1週間のうち何日/時間帯に営業している | |
| daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun / 月｜火｜水｜木｜金｜土｜日 | |
| allDay | 0..1 | boolean | The Location is open all day / その場所は終日営業している | |
| openingTime | 0..1 | time | Time that the Location opens / 場所が開く時間 | |
| closingTime | 0..1 | time | Time that the Location closes / 場所が閉まる時間 | |
| availabilityExceptions | 0..1 | string | Description of availability exceptions / 利用可能の例外についての説明 | |
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location / 場所のために運営されているサービスへのアクセスを提供する技術的なエンドポイント | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Location | 0..* | Location | 物理的な場所の詳細情報と位置情報 | |||||
| id | Σ | 0..1 | id | このアーティファクトの論理ID | ||||
| meta | Σ | 0..1 | Meta | 「リソースに関するメタデータ」 | ||||
| implicitRules | ?!Σ | 0..1 | uri | このコンテンツが作成されたルールセット | ||||
| language | 0..1 | code | 「リソースコンテンツの言語」(Risōsukontentsu no gengo) Binding: CommonLanguages (preferred): 「人間の言語。」(Ningen no gengo.)
| |||||
| text | 0..1 | Narrative | 「人間の解釈のためのリソースのテキスト要約」 | |||||
| contained | 0..* | Resource | 「含まれている、インラインのリソース」(Fukuma rete iru, inrain no risōsu) | |||||
| extension | 0..* | Extension | 実装によって定義される追加コンテンツ | |||||
| modifierExtension | ?! | 0..* | Extension | 無視できない拡張機能 (Mushi dekinai kakuchou kinou) | ||||
| identifier | Σ | 0..* | Identifier | Unique code or number identifying the location to its users / ユーザに場所を特定する一意のコードまたは番号 | ||||
| status | ?!Σ | 0..1 | code | active | suspended | inactive / アクティブ|中断|非アクティブ Binding: LocationStatus (required): 「場所がまだ使用されているかどうかを示します。」(Basho ga mada shiyou sarete iru ka dou ka wo shimeshimasu.) | ||||
| operationalStatus | Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) / ロケーションの運用ステータス（通常、ベッド/部屋のみ） Binding: hl7VS-bedStatus (preferred): 「通常ベッド/部屋が位置する場所の稼働状況」 | ||||
| name | Σ | 0..1 | string | Name of the location as used by humans / 人間が使用する場所の名前 | ||||
| alias | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past / その場所が過去に知られていた、または以前から知られていた別名のリスト | |||||
| description | Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name / 名前以外の場所を識別するための詳細情報として表示できる場所に関する追加の詳細 | ||||
| mode | Σ | 0..1 | code | instance | kind / インスタンス|種類 Binding: LocationMode (required): 「リソースインスタンスが特定の場所を表すのか、場所のクラスを表すのかを示します。」 | ||||
| type | Σ | 0..* | CodeableConcept | Type of function performed / 実行される機能のタイプ Binding: ServiceDeliveryLocationRoleType (extensible): 「場所で行われる機能のタイプを示します。」(Basho de okonawareru kinou no taipu wo shimesu.) | ||||
| telecom | 0..* | ContactPoint | Contact details of the location / 所在地の連絡先 | |||||
| address | 0..1 | Address | Physical location / 物理的な場所 | |||||
| physicalType | Σ | 0..1 | CodeableConcept | Physical form of the location / 場所の物理的な形態 Binding: LocationType (example): 場所の実体形態。 | ||||
| position | 0..1 | BackboneElement | The absolute geographic location / 絶対的な地理的位置 | |||||
| id | 0..1 | string | エレメント相互参照のためのユニークID | |||||
| extension | 0..* | Extension | 実装によって定義される追加コンテンツ | |||||
| modifierExtension | ?!Σ | 0..* | Extension | 「認識されなくても無視できない拡張機能」(Ninshiki sarenakutemo mushi dekinai kakuchou kinou) | ||||
| longitude | 1..1 | decimal | Longitude with WGS84 datum / WGS84データの経度 | |||||
| latitude | 1..1 | decimal | Latitude with WGS84 datum / WGS84データの緯度 | |||||
| altitude | 0..1 | decimal | Altitude with WGS84 datum / WGS84データによる高度 | |||||
| managingOrganization | Σ | 0..1 | Reference(JP Core Organization Profile) | Organization responsible for provisioning and upkeep / プロビジョニングと維持管理を担当する組織 | ||||
| partOf | 0..1 | Reference(JP Core Location Profile) | Another Location this one is physically a part of / この場所が物理的に存在するもう一つの場所 | |||||
| hoursOfOperation | 0..* | BackboneElement | What days/times during a week is this location usually open / この場所は通常、1週間のうち何日/時間帯に営業している | |||||
| id | 0..1 | string | エレメント相互参照のためのユニークID | |||||
| extension | 0..* | Extension | 実装によって定義される追加コンテンツ | |||||
| modifierExtension | ?!Σ | 0..* | Extension | 「認識されなくても無視できない拡張機能」(Ninshiki sarenakutemo mushi dekinai kakuchou kinou) | ||||
| daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun / 月｜火｜水｜木｜金｜土｜日 Binding: DaysOfWeek (required): 曜日 (Youbi) | |||||
| allDay | 0..1 | boolean | The Location is open all day / その場所は終日営業している | |||||
| openingTime | 0..1 | time | Time that the Location opens / 場所が開く時間 | |||||
| closingTime | 0..1 | time | Time that the Location closes / 場所が閉まる時間 | |||||
| availabilityExceptions | 0..1 | string | Description of availability exceptions / 利用可能の例外についての説明 | |||||
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location / 場所のために運営されているサービスへのアクセスを提供する技術的なエンドポイント | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Location.language | preferred | CommonLanguages
| ||||
| Location.status | required | LocationStatus | ||||
| Location.operationalStatus | preferred | Hl7VSBedStatus | ||||
| Location.mode | required | LocationMode | ||||
| Location.type | extensible | ServiceDeliveryLocationRoleType | ||||
| Location.physicalType | example | LocationType | ||||
| Location.hoursOfOperation.daysOfWeek | required | DaysOfWeek |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | すべてのFHIR要素は、@valueまたはchildrenを持っている必要があります。 : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | 「拡張機能または値[x]のいずれかが必要です。両方ではありません。」 : extension.exists() != value.exists() |
Other representations of profile: CSV, Excel, Schematron
本プロファイルで定義された必須項目はない。
本プロファイルで追加定義された拡張はない。
| コンフォーマンス | パラメータ | 型 | 例 |
|---|---|---|---|
| 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 |
次の検索パラメータは必須でサポートされなければならない。
name 検索パラメータを使用して、任意の名前パートによる文字列検索をサポートしなければならない（SHALL）
GET [base]/Location?name=[string]
例：
GET [base]/Location?name=３南
名前が一致するLocationリソースを含むBundleを取得する。
identifier 検索パラメータを使用して、ロケーションIDなどの識別子によるLocationの検索をサポートしなければならない（SHALL）
GET [base]/Location?identifier={system|}[code]
例：
GET [base]/Location?identifier=http://myhospital.com/fhir/Locationid|1234
指定された識別子に一致するLocationリソースを含むBundleを取得する。
address 検索パラメータを使用して、住所テキストによる文字列検索をサポートしなければならない（SHALL）
GET [base]/Location?address=[string]
例：
GET [base]/Location?address=東京都文京区本郷７丁目３−１
住所文字列が一致するLocationリソースを含むBundleを取得する。
address-city 検索パラメータを使用して、住所の市町村名によるLocationの検索をサポートすることが望ましい（SHOULD）
GET [base]/Location?address-city=[string]
例：
GET [base]/Location?address-city=文京区
指定された住所の市町村名が一致するLocationリソースを含むBundleを取得する。
address-state 検索パラメータを使用して、住所の都道府県名によるLocationの検索をサポートすることが望ましい（SHOULD）
GET [base]/Location?address-state=[string]
例：
GET [base]/Location?address-state=東京都
指定された住所の都道府県名が一致するLocationリソースを含むBundleを取得する。
address-postalcode 検索パラメータを使用して、住所の郵便番号によるLocationの検索をサポートすることが望ましい（SHOULD）
GET [base]/Location?address-postalcode=[string]
例：
GET [base]/Location?address-postalcode=1130033
指定された住所の郵便番号が一致するLocationリソースを含むBundleを取得する。
追加検索パラメータは定義しない。