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

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

Resource Profile: JP Core FamilyMemberHistory Profile

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

JP_FamilyMemberHistory

Title

JP Core FamilyMemberHistory Profile

Status Active ( 2023-10-31 )
Copyright

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

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


本プロファイルは、JP_FamilyMemberHistoryリソースの記録・更新・検索を行う上で、準拠するべき必須となる要素や、サポートすべき拡張、用語、検索パラメータを定義する。

スコープ

  • JP_FamilyMemberHistoryは、FHIRワークフロー仕様のイベントリソースの1つである。
  • 本プロファイルは、対象者に関連する特定の個人の重要な健康状態を記録する。この情報は、さまざまなレベルの正確さで知ることができる。正確な状態(喘息)がわかっている場合もあれば、あまり正確でない場合(ある種のがん)もある。同様に、人物を特定できる場合もあれば(e.g. 私の叔母(母方の長女)である幸子)、その人物が叔父であることだけがわかっている場合もある。
  • 本プロファイルは、特定の家族の「初歩的な」家族史を把握するために使用される単純な構造を表している。しかし、遺伝子解析やその他の分析に有用な、より厳密な歴史を把握するための基礎とすることもできる。 - 例として、Genetic Pedigreeプロファイルを参照すること。
  • JP_FamilyMemberHistoryインスタンスへの参照をListリソースインスタンスに結合することで、個人の家族歴全体を表現することができる。

想定シナリオ

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

  • JP_FamilyMemberHistoryリソースの記録・更新・検索

プロファイル定義

Usage:

プロファイル詳細

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory 0..*FamilyMemberHistoryInformation about patient's relatives, relevant for patient. 患者の家族に関する情報のうち、患者に関連する情報(家族歴)
... patient 1..1Reference(JP Core Patient Profile)患者の歴史はについてです / Patient history is about
... reasonReference 0..*Reference(QuestionnaireResponse | DocumentReference | JP Core AllergyIntolerance Profile | JP Core Condition Profile | JP Core Observation Common Profile | JP Core DiagnosticReport Common Profile)なぜ家族の歴史が演奏されたのですか? / Why was family member history performed?

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C0..*FamilyMemberHistoryInformation about patient's relatives, relevant for patient. 患者の家族に関する情報のうち、患者に関連する情報(家族歴)
... id Σ0..1idこのアーティファクトの論理ID / Logical id of this artifact
... meta Σ0..1Metaリソースに関するメタデータ / Metadata about the resource
... implicitRules ?!Σ0..1uriこのコンテンツが作成されたルールのセット / A set of rules under which this content was created
... language 0..1codeリソースコンテンツの言語 / Language of the resource content
Binding: CommonLanguages (preferred): 人間の言語。 / A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1Narrative人間の解釈のためのリソースのテキスト概要 / Text summary of the resource, for human interpretation
... contained 0..*Resourceインラインリソースが含まれています / Contained, inline Resources
... extension 0..*Extension実装で定義された追加のコンテンツ / Additional content defined by implementations
... modifierExtension ?!0..*Extension無視できない拡張機能 / Extensions that cannot be ignored
... identifier Σ0..*Identifierこのレコードの外部ID / External Id(s) for this record
... instantiatesCanonical Σ0..*canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)FHIRプロトコルまたは定義をインスタンス化します / Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uri外部プロトコルまたは定義をインスタンス化します / Instantiates external protocol or definition
... status ?!Σ1..1code部分的|完了|エラーに入った|健康と知られていない / partial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required): 家族歴史記録のステータスを識別するコード。 / A code that identifies the status of the family history record.

... dataAbsentReason Σ0..1CodeableConceptサブジェクト未知の|差し控え|観察できない|延期 / subject-unknown | withheld | unable-to-obtain | deferred
Binding: FamilyHistoryAbsentReason (example): 家族の歴史が利用できない理由を説明するコード。 / Codes describing the reason why a family member's history is not available.

... patient Σ1..1Reference(JP Core Patient Profile)患者の歴史はについてです / Patient history is about
... date Σ0..1dateTime履歴が記録されたとき、または最後に更新されたとき / When history was recorded or last updated
... name Σ0..1string家族が説明した / The family member described
... relationship Σ1..1CodeableConcept主題との関係 / Relationship to the subject
Binding: FamilyMember (example): 患者と関連者との関係の性質は、家族の歴史に記載されています。 / The nature of the relationship between the patient and the related person being described in the family member history.

... sex Σ0..1CodeableConcept男性|女性|その他|わからない / male | female | other | unknown
Binding: AdministrativeGender (extensible): 出生登録に文書化された出生時に割り当てられた性別を説明するコード。 / Codes describing the sex assigned at birth as documented on the birth registration.

... born[x] C0..1(おおよそ)生年月日 / (approximate) date of birth
.... bornPeriodPeriod
.... bornDatedate
.... bornStringstring
... age[x] ΣC0..1(おおよそ)年齢 / (approximate) age
.... ageAgeAge
.... ageRangeRange
.... ageStringstring
... estimatedAge ΣC0..1boolean年齢は推定されていますか? / Age is estimated?
... deceased[x] Σ0..1死?何歳/いつ? / Dead? How old/when?
.... deceasedBooleanboolean
.... deceasedAgeAge
.... deceasedRangeRange
.... deceasedDatedate
.... deceasedStringstring
... reasonCode Σ0..*CodeableConceptなぜ家族の歴史が演奏されたのですか? / Why was family member history performed?
Binding: SNOMEDCTClinicalFindings (example): 家族の歴史が行われた理由を示すコード。 / Codes indicating why the family member history was done.


... reasonReference Σ0..*Reference(QuestionnaireResponse | DocumentReference | JP Core AllergyIntolerance Profile | JP Core Condition Profile | JP Core Observation Common Profile | JP Core DiagnosticReport Common Profile)なぜ家族の歴史が演奏されたのですか? / Why was family member history performed?
... note 0..*Annotation関連者についての一般的なメモ / General note about related person
... condition 0..*BackboneElement関連者が持っていた状態 / Condition that the related person had
.... id 0..1string要素間参照のための一意のID / 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..1CodeableConcept関係が被る状態 / Condition suffered by relation
Binding: Condition/Problem/DiagnosisCodes (example): 状態または診断の識別。 / Identification of the Condition or diagnosis.

.... outcome 0..1CodeableConcept故人|永久障害|等 / deceased | permanent disability | etc.
Binding: ConditionOutcomeCodes (example): 患者の状態の結果。例えば死、永久障害、一時的な障害など。 / The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.

.... contributedToDeath 0..1boolean状態が死因に貢献したかどうか / Whether the condition contributed to the cause of death
.... onset[x] 0..1条件が最初に現れたとき / When condition first manifested
..... onsetAgeAge
..... onsetRangeRange
..... onsetPeriodPeriod
..... onsetStringstring
.... note 0..*Annotation状態に関する追加情報 / Extra information about condition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
FamilyMemberHistory.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
FamilyMemberHistory.statusrequiredFamilyHistoryStatus
http://hl7.org/fhir/ValueSet/history-status|4.0.1
from the FHIR Standard
FamilyMemberHistory.dataAbsentReasonexampleFamilyHistoryAbsentReason
http://hl7.org/fhir/ValueSet/history-absent-reason
from the FHIR Standard
FamilyMemberHistory.relationshipexampleFamilyMember
http://terminology.hl7.org/ValueSet/v3-FamilyMember
FamilyMemberHistory.sexextensibleAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
FamilyMemberHistory.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
FamilyMemberHistory.condition.codeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
FamilyMemberHistory.condition.outcomeexampleConditionOutcomeCodes
http://hl7.org/fhir/ValueSet/condition-outcome
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorFamilyMemberHistoryリソースが別のリソースに含まれている場合、ネストされたリソースを含めてはなりません / If the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorFamilyMemberHistoryリソースが別のリソースに含まれている場合、それはリソースの他の場所から参照されるか、含有リソースを参照するものとします / 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
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorFamilyMemberHistoryリソースが別のリソースに含まれている場合、meta.versionidもmeta.lastupdatedも持ってはならない。 / If 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-5errorFamilyMemberHistory別のリソースにリソースが含まれている場合、セキュリティラベルはありません / If a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceFamilyMemberHistoryリソースには、堅牢な管理のための叙述(Narative)が必要です / A resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsすべてのFHIR要素には、@valueまたは子供が必要です / All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensions両方ではなく、拡張または値[x]が必要です / Must have either extensions or value[x], not both
: extension.exists() != value.exists()
fhs-1errorFamilyMemberHistory年齢[x]または生まれ[x]を持つことができますが、両方ではありません / Can have age[x] or born[x], but not both
: age.empty() or born.empty()
fhs-2errorFamilyMemberHistory年齢[x]が存在する場合にのみ推定される可能性があります / Can only have estimatedAge if age[x] is present
: age.exists() or estimatedAge.empty()

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory 0..*FamilyMemberHistoryInformation about patient's relatives, relevant for patient. 患者の家族に関する情報のうち、患者に関連する情報(家族歴)
... patient 1..1Reference(JP Core Patient Profile)患者の歴史はについてです / Patient history is about
... reasonReference 0..*Reference(QuestionnaireResponse | DocumentReference | JP Core AllergyIntolerance Profile | JP Core Condition Profile | JP Core Observation Common Profile | JP Core DiagnosticReport Common Profile)なぜ家族の歴史が演奏されたのですか? / Why was family member history performed?

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C0..*FamilyMemberHistoryInformation about patient's relatives, relevant for patient. 患者の家族に関する情報のうち、患者に関連する情報(家族歴)
... id Σ0..1idこのアーティファクトの論理ID / Logical id of this artifact
... meta Σ0..1Metaリソースに関するメタデータ / Metadata about the resource
... implicitRules ?!Σ0..1uriこのコンテンツが作成されたルールのセット / A set of rules under which this content was created
... language 0..1codeリソースコンテンツの言語 / Language of the resource content
Binding: CommonLanguages (preferred): 人間の言語。 / A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1Narrative人間の解釈のためのリソースのテキスト概要 / Text summary of the resource, for human interpretation
... contained 0..*Resourceインラインリソースが含まれています / Contained, inline Resources
... extension 0..*Extension実装で定義された追加のコンテンツ / Additional content defined by implementations
... modifierExtension ?!0..*Extension無視できない拡張機能 / Extensions that cannot be ignored
... identifier Σ0..*Identifierこのレコードの外部ID / External Id(s) for this record
... instantiatesCanonical Σ0..*canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)FHIRプロトコルまたは定義をインスタンス化します / Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uri外部プロトコルまたは定義をインスタンス化します / Instantiates external protocol or definition
... status ?!Σ1..1code部分的|完了|エラーに入った|健康と知られていない / partial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required): 家族歴史記録のステータスを識別するコード。 / A code that identifies the status of the family history record.

... dataAbsentReason Σ0..1CodeableConceptサブジェクト未知の|差し控え|観察できない|延期 / subject-unknown | withheld | unable-to-obtain | deferred
Binding: FamilyHistoryAbsentReason (example): 家族の歴史が利用できない理由を説明するコード。 / Codes describing the reason why a family member's history is not available.

... patient Σ1..1Reference(JP Core Patient Profile)患者の歴史はについてです / Patient history is about
... date Σ0..1dateTime履歴が記録されたとき、または最後に更新されたとき / When history was recorded or last updated
... name Σ0..1string家族が説明した / The family member described
... relationship Σ1..1CodeableConcept主題との関係 / Relationship to the subject
Binding: FamilyMember (example): 患者と関連者との関係の性質は、家族の歴史に記載されています。 / The nature of the relationship between the patient and the related person being described in the family member history.

... sex Σ0..1CodeableConcept男性|女性|その他|わからない / male | female | other | unknown
Binding: AdministrativeGender (extensible): 出生登録に文書化された出生時に割り当てられた性別を説明するコード。 / Codes describing the sex assigned at birth as documented on the birth registration.

... born[x] C0..1(おおよそ)生年月日 / (approximate) date of birth
.... bornPeriodPeriod
.... bornDatedate
.... bornStringstring
... age[x] ΣC0..1(おおよそ)年齢 / (approximate) age
.... ageAgeAge
.... ageRangeRange
.... ageStringstring
... estimatedAge ΣC0..1boolean年齢は推定されていますか? / Age is estimated?
... deceased[x] Σ0..1死?何歳/いつ? / Dead? How old/when?
.... deceasedBooleanboolean
.... deceasedAgeAge
.... deceasedRangeRange
.... deceasedDatedate
.... deceasedStringstring
... reasonCode Σ0..*CodeableConceptなぜ家族の歴史が演奏されたのですか? / Why was family member history performed?
Binding: SNOMEDCTClinicalFindings (example): 家族の歴史が行われた理由を示すコード。 / Codes indicating why the family member history was done.


... reasonReference Σ0..*Reference(QuestionnaireResponse | DocumentReference | JP Core AllergyIntolerance Profile | JP Core Condition Profile | JP Core Observation Common Profile | JP Core DiagnosticReport Common Profile)なぜ家族の歴史が演奏されたのですか? / Why was family member history performed?
... note 0..*Annotation関連者についての一般的なメモ / General note about related person
... condition 0..*BackboneElement関連者が持っていた状態 / Condition that the related person had
.... id 0..1string要素間参照のための一意のID / 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..1CodeableConcept関係が被る状態 / Condition suffered by relation
Binding: Condition/Problem/DiagnosisCodes (example): 状態または診断の識別。 / Identification of the Condition or diagnosis.

.... outcome 0..1CodeableConcept故人|永久障害|等 / deceased | permanent disability | etc.
Binding: ConditionOutcomeCodes (example): 患者の状態の結果。例えば死、永久障害、一時的な障害など。 / The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.

.... contributedToDeath 0..1boolean状態が死因に貢献したかどうか / Whether the condition contributed to the cause of death
.... onset[x] 0..1条件が最初に現れたとき / When condition first manifested
..... onsetAgeAge
..... onsetRangeRange
..... onsetPeriodPeriod
..... onsetStringstring
.... note 0..*Annotation状態に関する追加情報 / Extra information about condition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
FamilyMemberHistory.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
FamilyMemberHistory.statusrequiredFamilyHistoryStatus
http://hl7.org/fhir/ValueSet/history-status|4.0.1
from the FHIR Standard
FamilyMemberHistory.dataAbsentReasonexampleFamilyHistoryAbsentReason
http://hl7.org/fhir/ValueSet/history-absent-reason
from the FHIR Standard
FamilyMemberHistory.relationshipexampleFamilyMember
http://terminology.hl7.org/ValueSet/v3-FamilyMember
FamilyMemberHistory.sexextensibleAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
FamilyMemberHistory.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
FamilyMemberHistory.condition.codeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
FamilyMemberHistory.condition.outcomeexampleConditionOutcomeCodes
http://hl7.org/fhir/ValueSet/condition-outcome
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorFamilyMemberHistoryリソースが別のリソースに含まれている場合、ネストされたリソースを含めてはなりません / If the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorFamilyMemberHistoryリソースが別のリソースに含まれている場合、それはリソースの他の場所から参照されるか、含有リソースを参照するものとします / 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
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorFamilyMemberHistoryリソースが別のリソースに含まれている場合、meta.versionidもmeta.lastupdatedも持ってはならない。 / If 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-5errorFamilyMemberHistory別のリソースにリソースが含まれている場合、セキュリティラベルはありません / If a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceFamilyMemberHistoryリソースには、堅牢な管理のための叙述(Narative)が必要です / A resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsすべてのFHIR要素には、@valueまたは子供が必要です / All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensions両方ではなく、拡張または値[x]が必要です / Must have either extensions or value[x], not both
: extension.exists() != value.exists()
fhs-1errorFamilyMemberHistory年齢[x]または生まれ[x]を持つことができますが、両方ではありません / Can have age[x] or born[x], but not both
: age.empty() or born.empty()
fhs-2errorFamilyMemberHistory年齢[x]が存在する場合にのみ推定される可能性があります / Can only have estimatedAge if age[x] is present
: age.exists() or estimatedAge.empty()

 

Other representations of profile: CSV, Excel, Schematron

必須要素

本プロファイルに準拠するためには、次の項目の値が存在しなければならない。

  • patient : 本リソースを有する患者
  • relationship : 患者と家族との関係の種類(父、母、兄弟など)
  • status : 家族歴のステータス(部分的 | 完全 | 記録エラー | 健康状態不明)

Extensions定義

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

利用方法

OperationおよびSearch Parameter 一覧

Search Parameter一覧

コンフォーマンス パラメータ
SHALL identifier token GET [base]/FamilyMemberHistory?identifier=http://myhospital.com/fhir/gamilymemberhistory|123
SHOULD patient reference GET [base]/FamilyMemberHistory?patient=Patient/123
MAY patient,relationship reference,reference GET [base]/FamilyMemberHistory?patient=Patient/123&relationship=FAMMEMB
MAY patient,status reference,code GET [base]/FamilyMemberHistory?patient=Patient/123&status=completed
必須検索パラメータ

本プロファイルに準拠するためには、以下の検索パラメータをサポートしなければならない(SHALL

  1. 検索パラメータidentifierを指定し、レコードIDなどの識別子によりFamilyMemberHistoryを検索

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

    例:

    GET [base]/FamilyMemberHistory?identifier=http://myhospital.com/fhir/familymemberhistory|123
    

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

推奨検索パラメータ
  1. 検索パラメータpatientを指定し、該当するすべてのFamilyMemberHistoryを検索

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

    例:

    GET [base]/FamilyMemberHistory?patient=Patient/123
    

    指定された患者のすべてのFamilyMemberHistoryを含むBundleを返却する。

追加検索パラメータ

オプションとして次の検索パラメータをサポートすることができる(MAY)

  1. 検索パラメータpatientとstatusの組みを指定し、該当するすべてのFamilyMemberHistoryを検索

    • OR検索のサポートを含む(例えば status={system|}[code],{system|}[code],…)

      GET [base]/FamilyMemberHistory?patient={reference}&status={system|}[code]{,{system|}[code],...}
      

      例:

      GET [base]/FamilyMemberHistory?patient=Patient/123&status=completed
      

      指定された患者のすべてのFamilyMemberHistoryを含むBundleを返却する。

オプション検索パラメータ

本プロファイルで追加定義されたオプション検索パラメータはない。

サンプル