HL7 FHIR JP Core ImplementationGuide
1.1.1 - ci-build Japan flag

HL7 FHIR JP Core ImplementationGuide - Local Development build (v1.1.1). See the Directory of published versions

Resource Profile: JP Core FamilyMemberHistory Profile

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

JP_FamilyMemberHistory
Title

JP Core FamilyMemberHistory Profile
Status Active ( 2022-10-24 )
Copyright

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

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


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

スコープ

  • JP_FamilyMemberHistoryは、FHIRワークフロー仕様のイベントリソースの１つである。
  • 本プロファイルは、対象者に関連する特定の個人の重要な健康状態を記録する。この情報は、さまざまなレベルの正確さで知ることができる。正確な状態（喘息）がわかっている場合もあれば、あまり正確でない場合（ある種のがん）もある。同様に、人物を特定できる場合もあれば（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. 患者の家族に関する情報のうち、患者に関連する情報（家族歴）
... text 0..1NarrativeText summary of the resource, for human interpretation. このリソースを人間が解釈するためのテキスト要約
... status 1..1codepartial | completed | entered-in-error | health-unknown この家族歴の記録ステータス（部分的 | 完全 | 記録エラー | 健康状態不明）
... dataAbsentReason 0..1CodeableConceptsubject-unknown | withheld | unable-to-obtain | deferred この家族歴が記録されない理由(対象家族を知らない | 情報の提供を拒否 | 聞き出すことができない | 後日情報を提供できる)
... patient 1..1Reference(JP Core Patient Profile)Patient history is about. この家族歴を有する患者
... date 0..1dateTimeWhen history was recorded or last updated. この家族歴の最終更新日
... name 0..1stringThe family member described. この家族の名前
... relationship 1..1CodeableConceptRelationship to the subject. この家族の患者との関係（父、母、兄弟など）
... sex 0..1CodeableConceptmale | female | other | unknown 性別（男性 | 女性 | その他 | 不明）
Binding: AdministrativeGender (extensible)
... born[x] 0..1Period, date, string(approximate) date of birth. この家族のおよその生年月日
... age[x] 0..1Age, Range, string(approximate) age. この家族のおよその年齢
... estimatedAge 0..1booleanAge is estimated? この家族の年齢は推定か？
... deceased[x] 0..1boolean, Age, Range, date, stringDead? How old/when? この家族は亡くなっているか、そうであれば何歳もしくはいつ亡くなったか
... reasonCode 0..*CodeableConceptWhy was family member history performed? なぜ家族歴が聴取されたか（契機となった患者の疾患）
... 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? なぜ家族歴が聴取されたか（契機となったFHIRリソース）
... note 0..*AnnotationGeneral note about related person. この家族に関するメモ
... condition 0..*BackboneElementCondition that the related person had. この家族が有する疾患
.... code 1..1CodeableConceptCondition suffered by relation. この家族の疾患
.... outcome 0..1CodeableConceptdeceased | permanent disability | etc. この疾患のアウトカム（死亡 | 後遺障害 | その他）
.... contributedToDeath 0..1booleanWhether the condition contributed to the cause of death. この疾患が死亡の原因となったかどうか
.... onset[x] 0..1Age, Range, Period, stringWhen condition first manifested. この疾患のオンセット
.... note 0..*AnnotationExtra information about condition. この疾患についての追加の情報メモ

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..1NarrativeText 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..1codepartial | completed | entered-in-error | health-unknown この家族歴の記録ステータス（部分的 | 完全 | 記録エラー | 健康状態不明）
Binding: FamilyHistoryStatus (required): 家族歴史記録のステータスを識別するコード。 / A code that identifies the status of the family history record.

... dataAbsentReason Σ0..1CodeableConceptsubject-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..1dateTimeWhen history was recorded or last updated. この家族歴の最終更新日
... name Σ0..1stringThe family member described. この家族の名前
... relationship Σ1..1CodeableConceptRelationship 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..1CodeableConceptmale | female | other | unknown 性別（男性 | 女性 | その他 | 不明）
Binding: AdministrativeGender (extensible)
... born[x] C0..1(approximate) date of birth. この家族のおよその生年月日
.... bornPeriodPeriod
.... bornDatedate
.... bornStringstring
... age[x] ΣC0..1(approximate) age. この家族のおよその年齢
.... ageAgeAge
.... ageRangeRange
.... ageStringstring
... estimatedAge ΣC0..1booleanAge is estimated? この家族の年齢は推定か？
... deceased[x] Σ0..1Dead? How old/when? この家族は亡くなっているか、そうであれば何歳もしくはいつ亡くなったか
.... deceasedBooleanboolean
.... deceasedAgeAge
.... deceasedRangeRange
.... deceasedDatedate
.... deceasedStringstring
... reasonCode Σ0..*CodeableConceptWhy 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? なぜ家族歴が聴取されたか（契機となったFHIRリソース）
... note 0..*AnnotationGeneral note about related person. この家族に関するメモ
... condition 0..*BackboneElementCondition 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..1CodeableConceptCondition suffered by relation. この家族の疾患
Binding: Condition/Problem/DiagnosisCodes (example): 状態または診断の識別。 / Identification of the Condition or diagnosis.

.... outcome 0..1CodeableConceptdeceased | permanent disability | etc. この疾患のアウトカム（死亡 | 後遺障害 | その他）
Binding: ConditionOutcomeCodes (example): 患者の状態の結果。例えば死、永久障害、一時的な障害など。 / The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.

.... contributedToDeath 0..1booleanWhether the condition contributed to the cause of death. この疾患が死亡の原因となったかどうか
.... onset[x] 0..1When condition first manifested. この疾患のオンセット
..... onsetAgeAge
..... onsetRangeRange
..... onsetPeriodPeriod
..... onsetStringstring
.... note 0..*AnnotationExtra information about condition. この疾患についての追加の情報メモ

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
FamilyMemberHistory.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
FamilyMemberHistory.statusrequiredFamilyHistoryStatus
FamilyMemberHistory.dataAbsentReasonexampleFamilyHistoryAbsentReason
FamilyMemberHistory.relationshipexampleFamilyMember
FamilyMemberHistory.sexextensibleAdministrativeGender
FamilyMemberHistory.reasonCodeexampleSNOMEDCTClinicalFindings
FamilyMemberHistory.condition.codeexampleCondition/Problem/DiagnosisCodes
FamilyMemberHistory.condition.outcomeexampleConditionOutcomeCodes

Constraints

IdGradePath(s)DetailsRequirements
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()

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory 0..*FamilyMemberHistoryInformation about patient's relatives, relevant for patient. 患者の家族に関する情報のうち、患者に関連する情報（家族歴）
... text 0..1NarrativeText summary of the resource, for human interpretation. このリソースを人間が解釈するためのテキスト要約
... status 1..1codepartial | completed | entered-in-error | health-unknown この家族歴の記録ステータス（部分的 | 完全 | 記録エラー | 健康状態不明）
... dataAbsentReason 0..1CodeableConceptsubject-unknown | withheld | unable-to-obtain | deferred この家族歴が記録されない理由(対象家族を知らない | 情報の提供を拒否 | 聞き出すことができない | 後日情報を提供できる)
... patient 1..1Reference(JP Core Patient Profile)Patient history is about. この家族歴を有する患者
... date 0..1dateTimeWhen history was recorded or last updated. この家族歴の最終更新日
... name 0..1stringThe family member described. この家族の名前
... relationship 1..1CodeableConceptRelationship to the subject. この家族の患者との関係（父、母、兄弟など）
... sex 0..1CodeableConceptmale | female | other | unknown 性別（男性 | 女性 | その他 | 不明）
Binding: AdministrativeGender (extensible)
... born[x] 0..1Period, date, string(approximate) date of birth. この家族のおよその生年月日
... age[x] 0..1Age, Range, string(approximate) age. この家族のおよその年齢
... estimatedAge 0..1booleanAge is estimated? この家族の年齢は推定か？
... deceased[x] 0..1boolean, Age, Range, date, stringDead? How old/when? この家族は亡くなっているか、そうであれば何歳もしくはいつ亡くなったか
... reasonCode 0..*CodeableConceptWhy was family member history performed? なぜ家族歴が聴取されたか（契機となった患者の疾患）
... 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? なぜ家族歴が聴取されたか（契機となったFHIRリソース）
... note 0..*AnnotationGeneral note about related person. この家族に関するメモ
... condition 0..*BackboneElementCondition that the related person had. この家族が有する疾患
.... code 1..1CodeableConceptCondition suffered by relation. この家族の疾患
.... outcome 0..1CodeableConceptdeceased | permanent disability | etc. この疾患のアウトカム（死亡 | 後遺障害 | その他）
.... contributedToDeath 0..1booleanWhether the condition contributed to the cause of death. この疾患が死亡の原因となったかどうか
.... onset[x] 0..1Age, Range, Period, stringWhen condition first manifested. この疾患のオンセット
.... note 0..*AnnotationExtra information about condition. この疾患についての追加の情報メモ

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..1NarrativeText 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..1codepartial | completed | entered-in-error | health-unknown この家族歴の記録ステータス（部分的 | 完全 | 記録エラー | 健康状態不明）
Binding: FamilyHistoryStatus (required): 家族歴史記録のステータスを識別するコード。 / A code that identifies the status of the family history record.

... dataAbsentReason Σ0..1CodeableConceptsubject-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..1dateTimeWhen history was recorded or last updated. この家族歴の最終更新日
... name Σ0..1stringThe family member described. この家族の名前
... relationship Σ1..1CodeableConceptRelationship 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..1CodeableConceptmale | female | other | unknown 性別（男性 | 女性 | その他 | 不明）
Binding: AdministrativeGender (extensible)
... born[x] C0..1(approximate) date of birth. この家族のおよその生年月日
.... bornPeriodPeriod
.... bornDatedate
.... bornStringstring
... age[x] ΣC0..1(approximate) age. この家族のおよその年齢
.... ageAgeAge
.... ageRangeRange
.... ageStringstring
... estimatedAge ΣC0..1booleanAge is estimated? この家族の年齢は推定か？
... deceased[x] Σ0..1Dead? How old/when? この家族は亡くなっているか、そうであれば何歳もしくはいつ亡くなったか
.... deceasedBooleanboolean
.... deceasedAgeAge
.... deceasedRangeRange
.... deceasedDatedate
.... deceasedStringstring
... reasonCode Σ0..*CodeableConceptWhy 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? なぜ家族歴が聴取されたか（契機となったFHIRリソース）
... note 0..*AnnotationGeneral note about related person. この家族に関するメモ
... condition 0..*BackboneElementCondition 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..1CodeableConceptCondition suffered by relation. この家族の疾患
Binding: Condition/Problem/DiagnosisCodes (example): 状態または診断の識別。 / Identification of the Condition or diagnosis.

.... outcome 0..1CodeableConceptdeceased | permanent disability | etc. この疾患のアウトカム（死亡 | 後遺障害 | その他）
Binding: ConditionOutcomeCodes (example): 患者の状態の結果。例えば死、永久障害、一時的な障害など。 / The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.

.... contributedToDeath 0..1booleanWhether the condition contributed to the cause of death. この疾患が死亡の原因となったかどうか
.... onset[x] 0..1When condition first manifested. この疾患のオンセット
..... onsetAgeAge
..... onsetRangeRange
..... onsetPeriodPeriod
..... onsetStringstring
.... note 0..*AnnotationExtra information about condition. この疾患についての追加の情報メモ

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
FamilyMemberHistory.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
FamilyMemberHistory.statusrequiredFamilyHistoryStatus
FamilyMemberHistory.dataAbsentReasonexampleFamilyHistoryAbsentReason
FamilyMemberHistory.relationshipexampleFamilyMember
FamilyMemberHistory.sexextensibleAdministrativeGender
FamilyMemberHistory.reasonCodeexampleSNOMEDCTClinicalFindings
FamilyMemberHistory.condition.codeexampleCondition/Problem/DiagnosisCodes
FamilyMemberHistory.condition.outcomeexampleConditionOutcomeCodes

Constraints

IdGradePath(s)DetailsRequirements
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()

 

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を返却する。

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

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

サンプル