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 Observation SocialHistory Profile

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

JP_Observation_SocialHistory
Title

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

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

このプロファイルはObservationリソースに対して、生活背景のデータを送受信するための制約と拡張を定めたものである。

本プロファイル説明は、患者に付属する一項目分のバイタルサイン情報について、情報の登録や検索、取得のために、JP_Observation_SocialHistoryリソースを使用するにあたっての、最低限の制約を記述したものである。 JP_Observation_SocialHistory リソースに対して本プロファイルに準拠する場合に必須となる要素や、サポートすべき拡張、用語、検索パラメータを定義する。

背景および想定シナリオ

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

  • Patientリソースから指定された日時、期間での患者生活背景情報の参照
  • Patientリソースから指定された患者生活背景情報項目に対する、指定された期間での患者生活背景情報の参照
  • 指定された期間や患者生活背景情報項目に対し、条件に合致する患者生活背景情報、または関連する他のリソース（Observationリソースや、Patientリソース等）の参照。

スコープ

Observationはヘルスケアの中心的な要素であり、診断の支援、進捗状況の監視、ベースラインやパターンの決定、さらには人口統計学的特性の把握に使用される。ほとんどのObservationは、いくつかのメタデータを持つ単純な名前/値のペアのアサーションであるが、いくつかの Observationは、他のObservationを論理的にグループ化したり、あるいはマルチコンポーネントのObservationであったりする。

本プロファイルでは上記想定シナリオにて用いられるObservationの用途がスコープであり、患者基本情報の中でも特に患者バイタルサインに該当する情報項目の１つを取り扱う際に、必要な要件を定義している。

プロファイル定義

Usage:

プロファイル詳細

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

This structure is derived from JP_Observation_Common

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* JP_Observation_Common 生活背景の情報
... Slices for category 1..* CodeableConcept このObservationを分類するコード
Slice: Unordered, Open by value:$this
.... category:socialHistory 1..1 CodeableConcept このObservationを分類するコード
Binding: JP Core Simple Observation Category ValueSet (required)
..... coding
...... system 0..1 uri Identity of the terminology system
Fixed Value: http://jpfhir.jp/fhir/core/CodeSystem/JP_SimpleObservationCategory_CS
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: social-history
... code 1..1 CodeableConcept このObservationの対象を特定するコード
Binding: JP Core Observation SocialHistory Code ValueSet (preferred)
... subject 1..1 Reference(JP Core Patient Profile) このObservationの対象となる患者や患者群、機器、場所に関する情報
... effective[x] 0..1 取得された結果が臨床的に確定された日時または期間
.... effectiveDateTime dateTime
.... effectivePeriod Period
... value[x] 0..1 取得された結果
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
... derivedFrom 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | JP Core Observation Common Profile | MolecularSequence | JP Core Observation SocialHistory Profile) このObservationの結果の導出元に関する情報。例えば、画像検査から取得された結果となる場合その導出元となる画像検査結果を示すImagingStudyリソース

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* JP_Observation_Common 生活背景の情報
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
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... 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
... 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
... status ?!Σ 1..1 code 結果の状態
Binding: ObservationStatus (required): Codes providing the status of an observation.


ele-1: All FHIR elements must have a @value or children
... Slices for category 1..* CodeableConcept このObservationを分類するコード
Slice: Unordered, Open by value:$this
Binding: JP Core Simple Observation Category ValueSet (preferred)
ele-1: All FHIR elements must have a @value or children
.... category:socialHistory 1..1 CodeableConcept このObservationを分類するコード
Binding: JP Core Simple Observation Category ValueSet (required)
ele-1: All FHIR elements must have a @value or children
... code Σ 1..1 CodeableConcept このObservationの対象を特定するコード
Binding: JP Core Observation SocialHistory Code ValueSet (preferred)
ele-1: All FHIR elements must have a @value or children
... subject Σ 1..1 Reference(JP Core Patient Profile) このObservationの対象となる患者や患者群、機器、場所に関する情報
ele-1: All FHIR elements must have a @value or children
... effective[x] Σ 0..1 取得された結果が臨床的に確定された日時または期間
ele-1: All FHIR elements must have a @value or children
.... effectiveDateTime dateTime
.... effectivePeriod Period
... value[x] ΣC 0..1 取得された結果
ele-1: All FHIR elements must have a @value or children
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
... derivedFrom Σ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | JP Core Observation Common Profile | MolecularSequence | JP Core Observation SocialHistory Profile) このObservationの結果の導出元に関する情報。例えば、画像検査から取得された結果となる場合その導出元となる画像検査結果を示すImagingStudyリソース
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* JP_Observation_Common 生活背景の情報
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier このObservationリソースの一意な識別ID
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | JP Core MedicationRequest Profile | JP Core MedicationRequest Injection Profile | NutritionOrder | ServiceRequest) このObservationが実施されることになった依頼や計画、提案に関する情報
... partOf Σ 0..* Reference(JP Core MedicationAdministration Profile | JP Core MedicationAdministration Injection Profile | JP Core MedicationDispenseBase Profile | MedicationStatement | JP Core Procedure Profile | JP Core Immunization Profile | ImagingStudy) このObservationが親イベントの一部を成す要素であるとき、その親イベントに関する情報
... status ?!Σ 1..1 code 結果の状態
Binding: ObservationStatus (required): Codes providing the status of an observation.

... Slices for category 1..* CodeableConcept このObservationを分類するコード
Slice: Unordered, Open by value:$this
Binding: JP Core Simple Observation Category ValueSet (preferred)
.... category:socialHistory 1..1 CodeableConcept このObservationを分類するコード
Binding: JP Core Simple Observation Category ValueSet (required)
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://jpfhir.jp/fhir/core/CodeSystem/JP_SimpleObservationCategory_CS
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: social-history
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... code Σ 1..1 CodeableConcept このObservationの対象を特定するコード
Binding: JP Core Observation SocialHistory Code ValueSet (preferred)
... subject Σ 1..1 Reference(JP Core Patient Profile) このObservationの対象となる患者や患者群、機器、場所に関する情報
... focus Σ 0..* Reference(Resource) 配偶者、親、胎児、ドナーなど、このObservationのsubject要素が実際の対象でない場合、その実際の対象に関する情報
... encounter Σ 0..1 Reference(JP Core Encounter Profile) 診察や入院など、このObservationが実施されるきっかけとなった診療イベントに関する情報
... effective[x] Σ 0..1 取得された結果が臨床的に確定された日時または期間
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued Σ 0..1 instant このバージョンのObservationが医療者に提供された日時。通常、結果を確認し検証後に提供される日時
... performer Σ 0..* Reference(JP Core Practitioner Profile | JP Core PractitionerRole Profile | JP Core Organization Profile | CareTeam | JP Core Patient Profile | RelatedPerson) このObservationの責任者/実施者に関する情報
... value[x] ΣC 0..1 取得された結果
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
... dataAbsentReason C 0..1 CodeableConcept このObservationのvalue[x]要素に期待される結果が存在しなかった場合、その理由
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..* CodeableConcept 高、低、正常等の結果のカテゴリ分けした評価
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..* Annotation このObservationに関するコメント
... bodySite 0..1 CodeableConcept 対象となった身体部位
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts

... method 0..1 CodeableConcept このObservationの実施方法
Binding: ObservationMethods (example): Methods for simple observations.

... specimen 0..1 Reference(Specimen) このObservationに使われた検体/標本に関する情報
... device 0..1 Reference(Device | DeviceMetric) このObservationでデータを得るために使われた測定機器に関する情報
... referenceRange C 0..* BackboneElement 基準範囲との比較による結果の解釈方法のガイダンス
obs-3: Must have at least a low or a high or text
.... 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
.... low C 0..1 SimpleQuantity Low Range, if relevant
.... high C 0..1 SimpleQuantity High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Σ 0..* Reference(JP Core Observation Common Profile | QuestionnaireResponse | MolecularSequence) このObservationに関連する子リソースに関する情報。このObservationに関連する/属するパネル検査や検査セットなどのObservationグループ
... derivedFrom Σ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | JP Core Observation Common Profile | MolecularSequence | JP Core Observation SocialHistory Profile) このObservationの結果の導出元に関する情報。例えば、画像検査から取得された結果となる場合その導出元となる画像検査結果を示すImagingStudyリソース
... component Σ 0..* BackboneElement 複合的な結果。例えば、血圧測定値ではそれを構成する収縮期および拡張期の値の組み合わせ
.... 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
.... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... value[x] Σ 0..1 Actual component result
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
.... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


.... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.3.0
from the FHIR Standard
Observation.categorypreferredJP_SimpleObservationCategory_VS (a valid code from JP Core Simple Observation Category CodeSystem)
http://jpfhir.jp/fhir/core/ValueSet/JP_SimpleObservationCategory_VS
from this IG
Observation.category:socialHistoryrequiredJP_SimpleObservationCategory_VS (a valid code from JP Core Simple Observation Category CodeSystem)
http://jpfhir.jp/fhir/core/ValueSet/JP_SimpleObservationCategory_VS
from this IG
Observation.codepreferredJP_ObservationSocialHistoryCode_VS
http://jpfhir.jp/fhir/core/ValueSet/JP_ObservationSocialHistoryCode_VS
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodexampleObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
dom-r4bwarningObservation.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()
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

This structure is derived from JP_Observation_Common

Summary

Mandatory: 3 elements(1 nested mandatory element)
Fixed: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the values of Observation.category

Differential View

This structure is derived from JP_Observation_Common

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* JP_Observation_Common 生活背景の情報
... Slices for category 1..* CodeableConcept このObservationを分類するコード
Slice: Unordered, Open by value:$this
.... category:socialHistory 1..1 CodeableConcept このObservationを分類するコード
Binding: JP Core Simple Observation Category ValueSet (required)
..... coding
...... system 0..1 uri Identity of the terminology system
Fixed Value: http://jpfhir.jp/fhir/core/CodeSystem/JP_SimpleObservationCategory_CS
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: social-history
... code 1..1 CodeableConcept このObservationの対象を特定するコード
Binding: JP Core Observation SocialHistory Code ValueSet (preferred)
... subject 1..1 Reference(JP Core Patient Profile) このObservationの対象となる患者や患者群、機器、場所に関する情報
... effective[x] 0..1 取得された結果が臨床的に確定された日時または期間
.... effectiveDateTime dateTime
.... effectivePeriod Period
... value[x] 0..1 取得された結果
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
... derivedFrom 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | JP Core Observation Common Profile | MolecularSequence | JP Core Observation SocialHistory Profile) このObservationの結果の導出元に関する情報。例えば、画像検査から取得された結果となる場合その導出元となる画像検査結果を示すImagingStudyリソース

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* JP_Observation_Common 生活背景の情報
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
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... 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
... 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
... status ?!Σ 1..1 code 結果の状態
Binding: ObservationStatus (required): Codes providing the status of an observation.


ele-1: All FHIR elements must have a @value or children
... Slices for category 1..* CodeableConcept このObservationを分類するコード
Slice: Unordered, Open by value:$this
Binding: JP Core Simple Observation Category ValueSet (preferred)
ele-1: All FHIR elements must have a @value or children
.... category:socialHistory 1..1 CodeableConcept このObservationを分類するコード
Binding: JP Core Simple Observation Category ValueSet (required)
ele-1: All FHIR elements must have a @value or children
... code Σ 1..1 CodeableConcept このObservationの対象を特定するコード
Binding: JP Core Observation SocialHistory Code ValueSet (preferred)
ele-1: All FHIR elements must have a @value or children
... subject Σ 1..1 Reference(JP Core Patient Profile) このObservationの対象となる患者や患者群、機器、場所に関する情報
ele-1: All FHIR elements must have a @value or children
... effective[x] Σ 0..1 取得された結果が臨床的に確定された日時または期間
ele-1: All FHIR elements must have a @value or children
.... effectiveDateTime dateTime
.... effectivePeriod Period
... value[x] ΣC 0..1 取得された結果
ele-1: All FHIR elements must have a @value or children
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
... derivedFrom Σ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | JP Core Observation Common Profile | MolecularSequence | JP Core Observation SocialHistory Profile) このObservationの結果の導出元に関する情報。例えば、画像検査から取得された結果となる場合その導出元となる画像検査結果を示すImagingStudyリソース
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* JP_Observation_Common 生活背景の情報
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier このObservationリソースの一意な識別ID
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | JP Core MedicationRequest Profile | JP Core MedicationRequest Injection Profile | NutritionOrder | ServiceRequest) このObservationが実施されることになった依頼や計画、提案に関する情報
... partOf Σ 0..* Reference(JP Core MedicationAdministration Profile | JP Core MedicationAdministration Injection Profile | JP Core MedicationDispenseBase Profile | MedicationStatement | JP Core Procedure Profile | JP Core Immunization Profile | ImagingStudy) このObservationが親イベントの一部を成す要素であるとき、その親イベントに関する情報
... status ?!Σ 1..1 code 結果の状態
Binding: ObservationStatus (required): Codes providing the status of an observation.

... Slices for category 1..* CodeableConcept このObservationを分類するコード
Slice: Unordered, Open by value:$this
Binding: JP Core Simple Observation Category ValueSet (preferred)
.... category:socialHistory 1..1 CodeableConcept このObservationを分類するコード
Binding: JP Core Simple Observation Category ValueSet (required)
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://jpfhir.jp/fhir/core/CodeSystem/JP_SimpleObservationCategory_CS
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: social-history
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... code Σ 1..1 CodeableConcept このObservationの対象を特定するコード
Binding: JP Core Observation SocialHistory Code ValueSet (preferred)
... subject Σ 1..1 Reference(JP Core Patient Profile) このObservationの対象となる患者や患者群、機器、場所に関する情報
... focus Σ 0..* Reference(Resource) 配偶者、親、胎児、ドナーなど、このObservationのsubject要素が実際の対象でない場合、その実際の対象に関する情報
... encounter Σ 0..1 Reference(JP Core Encounter Profile) 診察や入院など、このObservationが実施されるきっかけとなった診療イベントに関する情報
... effective[x] Σ 0..1 取得された結果が臨床的に確定された日時または期間
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued Σ 0..1 instant このバージョンのObservationが医療者に提供された日時。通常、結果を確認し検証後に提供される日時
... performer Σ 0..* Reference(JP Core Practitioner Profile | JP Core PractitionerRole Profile | JP Core Organization Profile | CareTeam | JP Core Patient Profile | RelatedPerson) このObservationの責任者/実施者に関する情報
... value[x] ΣC 0..1 取得された結果
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
... dataAbsentReason C 0..1 CodeableConcept このObservationのvalue[x]要素に期待される結果が存在しなかった場合、その理由
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..* CodeableConcept 高、低、正常等の結果のカテゴリ分けした評価
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..* Annotation このObservationに関するコメント
... bodySite 0..1 CodeableConcept 対象となった身体部位
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts

... method 0..1 CodeableConcept このObservationの実施方法
Binding: ObservationMethods (example): Methods for simple observations.

... specimen 0..1 Reference(Specimen) このObservationに使われた検体/標本に関する情報
... device 0..1 Reference(Device | DeviceMetric) このObservationでデータを得るために使われた測定機器に関する情報
... referenceRange C 0..* BackboneElement 基準範囲との比較による結果の解釈方法のガイダンス
obs-3: Must have at least a low or a high or text
.... 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
.... low C 0..1 SimpleQuantity Low Range, if relevant
.... high C 0..1 SimpleQuantity High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Σ 0..* Reference(JP Core Observation Common Profile | QuestionnaireResponse | MolecularSequence) このObservationに関連する子リソースに関する情報。このObservationに関連する/属するパネル検査や検査セットなどのObservationグループ
... derivedFrom Σ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | JP Core Observation Common Profile | MolecularSequence | JP Core Observation SocialHistory Profile) このObservationの結果の導出元に関する情報。例えば、画像検査から取得された結果となる場合その導出元となる画像検査結果を示すImagingStudyリソース
... component Σ 0..* BackboneElement 複合的な結果。例えば、血圧測定値ではそれを構成する収縮期および拡張期の値の組み合わせ
.... 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
.... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... value[x] Σ 0..1 Actual component result
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
.... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


.... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.3.0
from the FHIR Standard
Observation.categorypreferredJP_SimpleObservationCategory_VS (a valid code from JP Core Simple Observation Category CodeSystem)
http://jpfhir.jp/fhir/core/ValueSet/JP_SimpleObservationCategory_VS
from this IG
Observation.category:socialHistoryrequiredJP_SimpleObservationCategory_VS (a valid code from JP Core Simple Observation Category CodeSystem)
http://jpfhir.jp/fhir/core/ValueSet/JP_SimpleObservationCategory_VS
from this IG
Observation.codepreferredJP_ObservationSocialHistoryCode_VS
http://jpfhir.jp/fhir/core/ValueSet/JP_ObservationSocialHistoryCode_VS
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodexampleObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
dom-r4bwarningObservation.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()
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

This structure is derived from JP_Observation_Common

Summary

Mandatory: 3 elements(1 nested mandatory element)
Fixed: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the values of Observation.category

 

Other representations of profile: CSV, Excel, Schematron

必須要素

本プロファイルでは、次の要素を持たなければならない。

  • status︓生活背景情報項目の状態は必須である
  • category︓このリソースが示す生活背景情報項目を分類するための区分であり、このプロファイルでは必須とする
  • code︓このリソースは何の生活背景情報項目であるかを示すため必須である
  • subject︓このリソースが示す生活背景情報項目が、どの患者のものかを示すため、このプロファイルでは参照するpatientリソースの定義を必須とする

Extension定義

このプロファイルでは拡張定義は行っていない。

利用方法

OperationおよびSearch Parameter 一覧

Search Parameter一覧

生活背景情報ユースケースのSearch Parameter一覧は共通情報プロファイルに記載されている。

検索時のcategoryパラメータは"vital-sign"となる。

Observation共通情報プロファイル#Search Parameter一覧

Operation一覧

ObservationリソースのOperation一覧の定義はユースケースに依存せず共通であるため、共通情報プロファイルに記載されている。

Observation共通情報プロファイル#Operation一覧

サンプル

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