HL7 FHIR JP Core ImplementationGuide
2.0.0-dev - ci-build Japan flag

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

Resource Profile: JP Core Encounter Profile

項目内容
定義URL http://jpfhir.jp/fhir/core/StructureDefinition/JP_Encounter
Version 2.0.0-dev
Name

JP_Encounter
Title

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

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

このプロファイルはEncounterリソースに対して、来院/入院情報のデータを送受信するための基礎となる制約と拡張を定めたものである。

本プロファイルは、患者の医療機関受診に関する情報の登録や検索、取得のために 、FHIR Encounter リソースを使用するにあたっての、最低限の制約を記述したものである。Encounter リソースに対して本プロファイルに準拠する場合に必須となる要素や、サポートすべき拡張、用語、検索パラメータを定義する。

背景および想定シナリオ

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

  • 患者番号・診察券番号による患者受診歴の検索
  • 患者番号・診察券番号による入院履歴の検索
  • 外来予約患者の来院状況の検索、一覧表示
  • その他、上記以外の他のリソースからの患者受診歴の参照（例：Observationリソースの encounterで参照される対象とする患者の受診や、CarePlanリソースのencounterで参照される患者の受診歴（入院歴））

範囲と使用方法

患者に関連したEncounterの情報はその利用される状況によって特徴づけられる。例えば、外来、救急、在宅医療、入院、およびオンライン受診の情報も含まれる。Encounterは入院前手続き、外来受診、入院、入院中の滞在、および退院などの一連のライフサイクルを含む。Encounterに含まれる、PractitionerやLocationといった情報は状況に応じて変更されていくことがある。

このようにEncounterの適用範囲は広範になるため、すべてのエレメントがすべての状況で利用されるとは限らない。このため、入院/退院に関連した情報は、Encounter内のhospitalizationエレメントに保持される。classエレメントはこれらの状況を区別するために使用され、これによりさらなる検証とビジネスルールの適用が導かれる。

また、どのビジネスイベントが新しいEncounterの開始につながるのか、あるいはEncounterにどのようなレベルの集計が使用されるのかについては、組織ごと（および管轄や国ごと）に大きな違いがある。例えば、入院中の外来診療/開業医への一回の来院は、それぞれ新しいEncounterのインスタンスにつながるかもしれないが、個別の運用や関係するシステムによっては、これが入院全体で一つのインスタンスに集約されることもあり得る。会計システムなどの財務的な理由またはその他の理由でEncounterのグループを導入する場合には、さらに多くの集約が行われる可能性がある。Encountersは、partOfエレメントを用いて他のEncountersの下に集約またはグループ化することができる。例についてはこちらのリンクを参照すること。

Encounterインスタンスは、入院前情報を表現するために実際の外来や入院が行われる前に存在することがある。これには、予定された開始日または予定された場所を表現するためにEncounterを使用することも含まれる。この場合、status要素は「planned」に設定される。

Hospitalizationコンポーネントは、入院イベントに関連する拡張情報を格納するためのものである。これは常に、Encounter自体と同じ期間であることが期待される。期間が異なる場合は、別のEncounterのインスタンスを使用して、このEncounterのインスタンスの一部としてpartOfエレメントを使用してこの情報を取り込むべきである。

ProcedureとEncounterはお互いへの参照を持つが、これらは異なるProcedureとするべきである。1つは、Encounterの間に行われたProcedure（Procedure.encounterに格納）、もう1つは、Encounterが別のProcedureの結果である場合（Encounter.indicationに格納）、例えば、以前のProcedureによる合併症を解決するためのフォローアップのEncounterなどである。

ステータス管理

Encounterのライフサイクルでは、多くのステータス(status)を遷移する。一般的に、これらは組織のワークフローの順に、 planned(計画), in-progress(進行中), finished/cancelled(終了/キャンセル)となる。
このステータス情報はしばしば他のことに使用され、その際にはステータス履歴の分析が必要となることもある。これは、Encounterのすべてのhistoryを検索し、それぞれの期間をチェックし、何らかの形で後処理を行うことで可能となる。しかし、このような負担を軽減するために（またはシステムがリソース履歴をサポートしていない場合のために）、statusHistoryコンポーネントが用意されている。

そのEncounterが「来院した/入院した」ということを判断できる、statusの値は存在しない。Encounterの使用法およびジネスプラクティス/ポリシ/ワークフロー/タイプがこの定義に影響を与える可能性がある。(例：急性期医療施設、高齢者医療センター、外来診療所、救急部、地域に根ざした診療所など）
arrived, triaged または in-progress のstatusは入院の開始と考えられ、入力されたhospitalizationサブコンポーネントの存在を意味する。

on leave のstatusは、例えば、患者が週末に帰宅することを許可された場合や、その他の形式の外部イベントの場合など、入院の一部である場合もあれば、そうでない場合もある。 Encounterには「入院した」という固定した定義はないので、例えば外来（日帰り手術-大腸内視鏡検査）などの例では、患者は入院しているとも考えられる。少なくとも、ステータスが「in-progress」の場合は、患者は入院していると考えられる。

境界線と関係性

Encounterリソースは予約情報を格納するために使用されるべきではなく、Appointmentリソースが予約情報のために使用されることが意図されている。多くのシステムでは、外来患者のEncounter（これはEncounterの範囲である）とAppointmentが同時に使用されていることに注意してほしい。FHIRでは、AppointmentはEncounterの日付を確定するために使用され、一方Encounterは実際の来院/入院等に関する情報、すなわち患者が現れることに適用される。
このように、「planned」のstatusのEncounterは、それを予定したAppointmentと同一ではないが、それは実際に発生する前のEncounterであり、Encounterが完了するまでに更新されることが期待される。患者の場所への到着は、必ずしもEncounterの開始を意味するものではない（例えば、患者が実際に施術者に診てもらうよりも1時間早く到着しても、Encounterの開始にはならない。）。

Appointmentは通常、Appointmentの計画段階、検索、空いている時間の場所の特定、そしてAppointmentの作成に使われる。このプロセスが完了し、Appointmentが開始されると、Appointmentは達成されたものとしてマークされ、新しく作成されたEncounterにリンクされる。
この新しいEncounterは、施設のある場所に入院したときに「arrived」状態で始まり、その後、病棟を移動した際には別のpartOfで関連付けられたEncounterが始まるかもしれない。

Communicationリソースは、直接の接触がない場合に、医療従事者と患者の間で同時に行われる対話に使用される。例としては、電話によるメッセージや、通信文書の送信などがある。通信資源には継続時間は記録されないが、送信時間と受信時間が含まれる可能性がある。

スコープ

外来における入院前受診、来院、入院診療における入院、滞在、退院といった、全ての患者受診を表す。

Encounterリソースは、class要素を用いて医療提供環境を特徴づけることができる。具体的な例としては以下の環境が想定されている。

  • 救急
  • 在宅診療
  • 入院前
  • 入院
  • 検査通院
  • 遠隔診療

Encounter リソースは発生単位が医療機関や組織ごとに異なる可能性がある。例えば、入院中に開業医が1回訪問するたびに新しいEncounterインスタンスが発生する可能性や、地域の慣行や関連システムによっては、入院全体で1つのインスタンスに集約される場合もある。

Encounterリソースは、partOf要素を使用して、他のEncounterインスタンスの下に集約できる。

またEncounterリソースは、受診前の情報を伝達するために生成することもできる。この場合、status要素は「planned」に設定される。患者の受信内容が入院に関連する場合は、hospitalization要素に入院イベントに関連する拡張情報を格納できる。
なおこの入院イベントの関連付けは、Encounterリソースのperiod要素で指定されている期間と同じ期間内であることが望ましい。もし期間が異なる場合は、別のEncounterインスタンスを使用し、このEncounterインスタンスの一部として情報を関連付ける必要がある。

プロファイル定義

Usage:

プロファイル詳細

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

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..* Encounter 患者にサービスが提供されている間の相互作用
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:associatedEncounter 0..1 Reference(Encounter) 関連するEncounter
URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
... identifier 0..* Identifier このEncounterが知られている識別子（複数可）
... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled + / 予定｜到着｜トリアージ｜進行中｜保留中｜終了｜キャンセル+
... statusHistory 0..* BackboneElement 過去のEncounterのステータス一覧【詳細参照】
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled + / 予定｜到着｜トリアージ｜進行中｜保留中｜終了｜キャンセル+.
.... period 1..1 Period そのエピソードが指定された状態になっていた時間
... class 1..1 Coding 患者とのEncounterの分類【詳細参照】
... classHistory 0..* BackboneElement 過去のEncounter classのリスト【詳細参照】
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency + / 入院｜外来｜外来｜救急＋
.... period 1..1 Period 指定されたクラスにエピソードがあった時間
... subject 0..1 Reference(JP Core Patient Profile | Group) The patient or group present at the encounter
... participant
.... individual 0..1 Reference(JP Core Practitioner Profile | JP Core PractitionerRole Profile | RelatedPerson) Persons involved in the encounter other than the patient
... reasonReference 0..* Reference(JP Core Condition Profile | JP Core Procedure Profile | JP Core Observation Common Profile | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis
.... condition 1..1 Reference(JP Core Condition Profile | JP Core Procedure Profile) The diagnosis or procedure relevant to the encounter
... hospitalization
.... origin 0..1 Reference(JP Core Location Profile | JP Core Organization Profile) The location/organization from which the patient came before admission
.... destination 0..1 Reference(JP Core Location Profile | JP Core Organization Profile) Location/organization to which the patient is discharged
... location
.... location 1..1 Reference(JP Core Location Profile) Location the encounter takes place
... serviceProvider 0..1 Reference(JP Core Organization Profile) The organization (facility) responsible for this encounter
... partOf 0..1 Reference(JP Core Encounter Profile) Another Encounter this encounter is part of

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..* Encounter 患者にサービスが提供されている間の相互作用
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:associatedEncounter 0..1 Reference(Encounter) 関連するEncounter
URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier Σ 0..* Identifier このEncounterが知られている識別子（複数可）
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled + / 予定｜到着｜トリアージ｜進行中｜保留中｜終了｜キャンセル+
Binding: EncounterStatus (required): Current state of the encounter.


ele-1: All FHIR elements must have a @value or children
... statusHistory 0..* BackboneElement 過去のEncounterのステータス一覧【詳細参照】
ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled + / 予定｜到着｜トリアージ｜進行中｜保留中｜終了｜キャンセル+.
Binding: EncounterStatus (required): Current state of the encounter.


ele-1: All FHIR elements must have a @value or children
.... period 1..1 Period そのエピソードが指定された状態になっていた時間
ele-1: All FHIR elements must have a @value or children
... class Σ 1..1 Coding 患者とのEncounterの分類【詳細参照】
Binding: ActEncounterCode (extensible): Classification of the encounter.


ele-1: All FHIR elements must have a @value or children
... classHistory 0..* BackboneElement 過去のEncounter classのリスト【詳細参照】
ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency + / 入院｜外来｜外来｜救急＋
Binding: ActEncounterCode (extensible): Classification of the encounter.


ele-1: All FHIR elements must have a @value or children
.... period 1..1 Period 指定されたクラスにエピソードがあった時間
ele-1: All FHIR elements must have a @value or children
... subject Σ 0..1 Reference(JP Core Patient Profile | Group) The patient or group present at the encounter
ele-1: All FHIR elements must have a @value or children
... reasonReference Σ 0..* Reference(JP Core Condition Profile | JP Core Procedure Profile | JP Core Observation Common Profile | ImmunizationRecommendation) Reason the encounter takes place (reference)
ele-1: All FHIR elements must have a @value or children
... serviceProvider 0..1 Reference(JP Core Organization Profile) The organization (facility) responsible for this encounter
ele-1: All FHIR elements must have a @value or children
... partOf 0..1 Reference(JP Core Encounter Profile) Another Encounter this encounter is part of
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..* Encounter 患者にサービスが提供されている間の相互作用
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:associatedEncounter 0..1 Reference(Encounter) 関連するEncounter
URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier このEncounterが知られている識別子（複数可）
... status ?!Σ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled + / 予定｜到着｜トリアージ｜進行中｜保留中｜終了｜キャンセル+
Binding: EncounterStatus (required): Current state of the encounter.

... statusHistory 0..* BackboneElement 過去のEncounterのステータス一覧【詳細参照】
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled + / 予定｜到着｜トリアージ｜進行中｜保留中｜終了｜キャンセル+.
Binding: EncounterStatus (required): Current state of the encounter.

.... period 1..1 Period そのエピソードが指定された状態になっていた時間
... class Σ 1..1 Coding 患者とのEncounterの分類【詳細参照】
Binding: ActEncounterCode (extensible): Classification of the encounter.

... classHistory 0..* BackboneElement 過去のEncounter classのリスト【詳細参照】
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency + / 入院｜外来｜外来｜救急＋
Binding: ActEncounterCode (extensible): Classification of the encounter.

.... period 1..1 Period 指定されたクラスにエピソードがあった時間
... type Σ 0..* CodeableConcept Specific type of encounter
Binding: EncounterType (example): A specific code indicating type of service provided


... serviceType Σ 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.

... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.

... subject Σ 0..1 Reference(JP Core Patient Profile | Group) The patient or group present at the encounter
... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant Σ 0..* BackboneElement List of participants involved in the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.


.... period 0..1 Period Period of time during the encounter that the participant participated
.... individual Σ 0..1 Reference(JP Core Practitioner Profile | JP Core PractitionerRole Profile | RelatedPerson) Persons involved in the encounter other than the patient
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period 0..1 Period The start and end time of the encounter
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode Σ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.


... reasonReference Σ 0..* Reference(JP Core Condition Profile | JP Core Procedure Profile | JP Core Observation Common Profile | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition Σ 1..1 Reference(JP Core Condition Profile | JP Core Procedure Profile) The diagnosis or procedure relevant to the encounter
.... use 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.

.... rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... hospitalization 0..1 BackboneElement Details about the admission to a healthcare service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin 0..1 Reference(JP Core Location Profile | JP Core Organization Profile) The location/organization from which the patient came before admission
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.

.... reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.

.... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.


.... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.


.... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.


.... destination 0..1 Reference(JP Core Location Profile | JP Core Organization Profile) Location/organization to which the patient is discharged
.... dischargeDisposition 0..1 CodeableConcept Category or kind of location after discharge
Binding: DischargeDisposition (example): Discharge Disposition.

... location 0..* BackboneElement List of locations where the patient has been
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location 1..1 Reference(JP Core Location Profile) Location the encounter takes place
.... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.

.... physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.

.... period 0..1 Period Time period during which the patient was present at the location
... serviceProvider 0..1 Reference(JP Core Organization Profile) The organization (facility) responsible for this encounter
... partOf 0..1 Reference(JP Core Encounter Profile) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.3.0
from the FHIR Standard
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.3.0
from the FHIR Standard
Encounter.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeexampleEncounterType
http://hl7.org/fhir/ValueSet/encounter-type
from the FHIR Standard
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Encounter.priorityexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard
Encounter.hospitalization.admitSourcepreferredAdmitSource
http://hl7.org/fhir/ValueSet/encounter-admit-source
from the FHIR Standard
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet
from the FHIR Standard
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy
from the FHIR Standard
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements
from the FHIR Standard
Encounter.hospitalization.dischargeDispositionexampleDischargeDisposition
http://hl7.org/fhir/ValueSet/encounter-discharge-disposition
from the FHIR Standard
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.3.0
from the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where(((id.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorEncounterIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
dom-r4bwarningEncounter.containedContaining new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..* Encounter 患者にサービスが提供されている間の相互作用
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:associatedEncounter 0..1 Reference(Encounter) 関連するEncounter
URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
... identifier 0..* Identifier このEncounterが知られている識別子（複数可）
... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled + / 予定｜到着｜トリアージ｜進行中｜保留中｜終了｜キャンセル+
... statusHistory 0..* BackboneElement 過去のEncounterのステータス一覧【詳細参照】
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled + / 予定｜到着｜トリアージ｜進行中｜保留中｜終了｜キャンセル+.
.... period 1..1 Period そのエピソードが指定された状態になっていた時間
... class 1..1 Coding 患者とのEncounterの分類【詳細参照】
... classHistory 0..* BackboneElement 過去のEncounter classのリスト【詳細参照】
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency + / 入院｜外来｜外来｜救急＋
.... period 1..1 Period 指定されたクラスにエピソードがあった時間
... subject 0..1 Reference(JP Core Patient Profile | Group) The patient or group present at the encounter
... participant
.... individual 0..1 Reference(JP Core Practitioner Profile | JP Core PractitionerRole Profile | RelatedPerson) Persons involved in the encounter other than the patient
... reasonReference 0..* Reference(JP Core Condition Profile | JP Core Procedure Profile | JP Core Observation Common Profile | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis
.... condition 1..1 Reference(JP Core Condition Profile | JP Core Procedure Profile) The diagnosis or procedure relevant to the encounter
... hospitalization
.... origin 0..1 Reference(JP Core Location Profile | JP Core Organization Profile) The location/organization from which the patient came before admission
.... destination 0..1 Reference(JP Core Location Profile | JP Core Organization Profile) Location/organization to which the patient is discharged
... location
.... location 1..1 Reference(JP Core Location Profile) Location the encounter takes place
... serviceProvider 0..1 Reference(JP Core Organization Profile) The organization (facility) responsible for this encounter
... partOf 0..1 Reference(JP Core Encounter Profile) Another Encounter this encounter is part of

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..* Encounter 患者にサービスが提供されている間の相互作用
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:associatedEncounter 0..1 Reference(Encounter) 関連するEncounter
URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier Σ 0..* Identifier このEncounterが知られている識別子（複数可）
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled + / 予定｜到着｜トリアージ｜進行中｜保留中｜終了｜キャンセル+
Binding: EncounterStatus (required): Current state of the encounter.


ele-1: All FHIR elements must have a @value or children
... statusHistory 0..* BackboneElement 過去のEncounterのステータス一覧【詳細参照】
ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled + / 予定｜到着｜トリアージ｜進行中｜保留中｜終了｜キャンセル+.
Binding: EncounterStatus (required): Current state of the encounter.


ele-1: All FHIR elements must have a @value or children
.... period 1..1 Period そのエピソードが指定された状態になっていた時間
ele-1: All FHIR elements must have a @value or children
... class Σ 1..1 Coding 患者とのEncounterの分類【詳細参照】
Binding: ActEncounterCode (extensible): Classification of the encounter.


ele-1: All FHIR elements must have a @value or children
... classHistory 0..* BackboneElement 過去のEncounter classのリスト【詳細参照】
ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency + / 入院｜外来｜外来｜救急＋
Binding: ActEncounterCode (extensible): Classification of the encounter.


ele-1: All FHIR elements must have a @value or children
.... period 1..1 Period 指定されたクラスにエピソードがあった時間
ele-1: All FHIR elements must have a @value or children
... subject Σ 0..1 Reference(JP Core Patient Profile | Group) The patient or group present at the encounter
ele-1: All FHIR elements must have a @value or children
... reasonReference Σ 0..* Reference(JP Core Condition Profile | JP Core Procedure Profile | JP Core Observation Common Profile | ImmunizationRecommendation) Reason the encounter takes place (reference)
ele-1: All FHIR elements must have a @value or children
... serviceProvider 0..1 Reference(JP Core Organization Profile) The organization (facility) responsible for this encounter
ele-1: All FHIR elements must have a @value or children
... partOf 0..1 Reference(JP Core Encounter Profile) Another Encounter this encounter is part of
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..* Encounter 患者にサービスが提供されている間の相互作用
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:associatedEncounter 0..1 Reference(Encounter) 関連するEncounter
URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier このEncounterが知られている識別子（複数可）
... status ?!Σ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled + / 予定｜到着｜トリアージ｜進行中｜保留中｜終了｜キャンセル+
Binding: EncounterStatus (required): Current state of the encounter.

... statusHistory 0..* BackboneElement 過去のEncounterのステータス一覧【詳細参照】
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled + / 予定｜到着｜トリアージ｜進行中｜保留中｜終了｜キャンセル+.
Binding: EncounterStatus (required): Current state of the encounter.

.... period 1..1 Period そのエピソードが指定された状態になっていた時間
... class Σ 1..1 Coding 患者とのEncounterの分類【詳細参照】
Binding: ActEncounterCode (extensible): Classification of the encounter.

... classHistory 0..* BackboneElement 過去のEncounter classのリスト【詳細参照】
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency + / 入院｜外来｜外来｜救急＋
Binding: ActEncounterCode (extensible): Classification of the encounter.

.... period 1..1 Period 指定されたクラスにエピソードがあった時間
... type Σ 0..* CodeableConcept Specific type of encounter
Binding: EncounterType (example): A specific code indicating type of service provided


... serviceType Σ 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.

... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.

... subject Σ 0..1 Reference(JP Core Patient Profile | Group) The patient or group present at the encounter
... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant Σ 0..* BackboneElement List of participants involved in the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.


.... period 0..1 Period Period of time during the encounter that the participant participated
.... individual Σ 0..1 Reference(JP Core Practitioner Profile | JP Core PractitionerRole Profile | RelatedPerson) Persons involved in the encounter other than the patient
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period 0..1 Period The start and end time of the encounter
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode Σ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.


... reasonReference Σ 0..* Reference(JP Core Condition Profile | JP Core Procedure Profile | JP Core Observation Common Profile | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition Σ 1..1 Reference(JP Core Condition Profile | JP Core Procedure Profile) The diagnosis or procedure relevant to the encounter
.... use 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.

.... rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... hospitalization 0..1 BackboneElement Details about the admission to a healthcare service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin 0..1 Reference(JP Core Location Profile | JP Core Organization Profile) The location/organization from which the patient came before admission
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.

.... reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.

.... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.


.... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.


.... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.


.... destination 0..1 Reference(JP Core Location Profile | JP Core Organization Profile) Location/organization to which the patient is discharged
.... dischargeDisposition 0..1 CodeableConcept Category or kind of location after discharge
Binding: DischargeDisposition (example): Discharge Disposition.

... location 0..* BackboneElement List of locations where the patient has been
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location 1..1 Reference(JP Core Location Profile) Location the encounter takes place
.... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.

.... physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.

.... period 0..1 Period Time period during which the patient was present at the location
... serviceProvider 0..1 Reference(JP Core Organization Profile) The organization (facility) responsible for this encounter
... partOf 0..1 Reference(JP Core Encounter Profile) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.3.0
from the FHIR Standard
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.3.0
from the FHIR Standard
Encounter.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeexampleEncounterType
http://hl7.org/fhir/ValueSet/encounter-type
from the FHIR Standard
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Encounter.priorityexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard
Encounter.hospitalization.admitSourcepreferredAdmitSource
http://hl7.org/fhir/ValueSet/encounter-admit-source
from the FHIR Standard
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet
from the FHIR Standard
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy
from the FHIR Standard
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements
from the FHIR Standard
Encounter.hospitalization.dischargeDispositionexampleDischargeDisposition
http://hl7.org/fhir/ValueSet/encounter-discharge-disposition
from the FHIR Standard
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.3.0
from the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where(((id.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorEncounterIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
dom-r4bwarningEncounter.containedContaining new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron

必須要素

Encounter リソースは、次の要素を持たなければならない。

  • status : 受診状況を示す。value set encounter-statusで定義された値から設定する必要がある。
    （planned/arrived/triaged/in-progress/onleave/finished/cancelled/entered-in-error/unknown）
  • class : 受診分類を示す。value set ActEncounterCodeで定義された値から設定する必要がある。
    （AMB/EMER/FLD/HH/IMP/ACUTE/NONAC/OBSENC/PRENC/SS/VR）

Extensions定義

JP Encounter リソースで使用される拡張は次の通りである。

  • Associated Encounter

    • リソースで関連付けを定義しているプロパティが存在しないEncounterを参照するために利用する

利用方法

OperationおよびSearch Parameter 一覧

Search Parameter一覧

コンフォーマンス パラメータ 型 例
SHALL identifier token GET [base]/Encounter?identifier=http://hl7.org/fhir/sid/jpsys|123456
SHOULD patient reference GET [base]/Encounter?patient=Patient/123456
SHOULD date, patient date, reference GET [base]/Encounter?date=eq2021-04-15&patient=Patient/123456
SHOULD class, patient token, reference GET [base]/Encounter?class=http://terminology.hl7.org/CodeSystem/v3-ActCode|EMER&patient=Patient/123456
SHOULD patient, type reference, token GET [base]/Encounter?patient=Patient/123456&type=http://terminology.hl7.org/CodeSystem/encounter-type|ADMS
SHOULD patient, status reference, token GET [base]/Encounter?patient=Patient/123456&status=arrived
必須検索パラメータ

  1. identifier 検索パラメータを使用して、診察番号等の識別子によるEncounterの検索をサポートしなければならない（SHALL）

    GET [base]/Encounter?identifier={system|}[token]

    例：

    GET [base]/Encounter?identifier=http://hl7.org/fhir/sid/jpsys|123456

    指定された識別子に一致するEncounterリソースを含むBundleを検索する。

推奨検索パラメータ

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

  1. patient 検索パラメータを使用して、識別子によるEncounterの検索をサポートすることが望ましい（SHOULD）

    GET [base]/Encounter?patient={reference}

    例：

    GET [base]/Encounter?patient=Patient/123456

    指定されたpatientに一致するEncounterリソースを含むBundleを検索する。

  2. date, patient 検索パラメータを使用して、識別子によるEncounterの検索をサポートすることが望ましい（SHOULD）

    GET [base]/Encounter?date={date}&patient={reference}

    例：

    GET [base]/Encounter?date=eq2021-04-15&patient=Patient/123456

    指定されたdate,patientに一致するEncounterリソースを含むBundleを検索する。

  3. class, patient 検索パラメータを使用して、識別子によるEncounterの検索をサポートすることが望ましい（SHOULD）

    GET [base]/Encounter?class={token}&patient={reference}

    例：

    GET [base]/Encounter?class=http://terminology.hl7.org/CodeSystem/v3-ActCode|EMER&patient=Patient/123456

    指定されたclass,patientに一致するEncounterリソースを含むBundleを検索する。

  4. patient, type 検索パラメータを使用して、識別子によるEncounterの検索をサポートすることが望ましい（SHOULD）

    GET [base]/Encounter?patient={reference}&type={token}

    例：

    GET [base]/Encounter?patient=Patient/123456&type=http://terminology.hl7.org/CodeSystem/encounter-type|ADMS

    指定されたpatient, typeに一致するEncounterリソースを含むBundleを検索する。

  5. patient, status 検索パラメータを使用して、識別子によるEncounterの検索をサポートすることが望ましい（SHOULD）

    GET [base]/Encounter?patient={reference}&status={token}

    例：

    GET [base]/Encounter?patientPatient/123456&status=arrive

    指定されたpatient, statusに一致するEncounterリソースを含むBundleを検索する。

Operation一覧

JP Encounter リソースに対して使用される操作は次の通りである。

  • $everything：[base]/Encounter/[id]/$everything
    • この操作が呼び出された特定のEncounterに関連する全ての情報を返す

Operation 詳細

$everything 操作

この操作は、この操作が呼び出された特定のEncounterリソースに関連する全ての情報を返す。 応答は "searchset" タイプのBundleリソースである。

この操作の公式なURLは以下である。

https://hl7.org/fhir/R4B/operation-encounter-everything.html

URL: [base]/Encounter/[id]/$everything

本操作は、べき等な操作である。

入力パラメータ
名前 多重度 型 説明
_since 0..1 instant 指定された日時以降に更新されたリソースのみが応答に含まれる。
_type 0..* code 応答に含むFHIRリソース型を、カンマ区切りで指定する。指定されない場合は、サーバは全てのリソース型を対象とする。
_count 0..1 integer Bundleの1ページに含まれるリソース件数を指定。
出力パラメータ
名前 多重度 型 説明
return 1..1 Bundle バンドルのタイプは"searchset"である。この操作の結果は、リソースとして直接返される。
例

リクエスト：単一のEncounterに関連する全てのリソースを取得する。

GET [base]/Encounter/example/$everything
[some headers]

レスポンス：指定されたEncounterに関連する全てのリソースを返す。

HTTP/1.1 200 OK
[other headers]

{
  "resourceType": "Bundle",
  "id": "p001",
  "meta": {
    "lastUpdated": "2020-01-06T15:11:11.447+00:00"
  },
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "http://example.org/fhir/Encounter/p001",
      "resource": {
        "resourceType": "Encounter",

          ・・・

       },
    }
  ]
}

サンプル

注意事項

Encounterリソースは、予定情報や予約の保存には使用されない。予約の保存にはAppointmentリソースを利用すること。FHIRでは、Appointmentは診察の日付を決定するのに利用されるのに対して、Encounterは実際に患者が来院して診察が実施されたことを表現する。 そのため、「計画済み」 status の Encounter は実際に発生する前の Encounter であり、診療行為が完了するまで更新されることが期待される。

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

  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
本実装ガイドへのご質問・ご指摘については、GitHub IssueおよびGitHub PullRequestにて受け付けております。