EHI Export Implementation Guide
0.1.0 - ci-build
EHI Export Implementation Guide
0.1.0 - ci-build
EHI Export Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://ehi-export.pointclickcare.com//StructureDefinition/familyMemberHistory | Version: 0.1.0 | |||
| Draft as of 2025-11-27 | Computable Name: EHIFamilyMemberHistory | |||
Significant health conditions for a person related to the patient relevant in the context of care for the patient.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  FamilyMemberHistory |
C | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient Constraints: fhs-1, fhs-2 |
  status |
?!Σ | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record. |
 patient |
Σ | 1..1 | Reference(Patient) | Patient history is about |
  relationship |
Σ | 1..1 | CodeableConcept | 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. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| FamilyMemberHistory.status | Base | required | FamilyHistoryStatus | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.relationship | Base | example | FamilyMember | 📦3.0.0 | THO v7.0 |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | FamilyMemberHistory | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | FamilyMemberHistory | 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-4 | error | FamilyMemberHistory | 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-5 | error | FamilyMemberHistory | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | FamilyMemberHistory | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| fhs-1 | error | FamilyMemberHistory | Can have age[x] or born[x], but not both |
age.empty() or born.empty()
|
| fhs-2 | error | FamilyMemberHistory | Can only have estimatedAge if age[x] is present |
age.exists() or estimatedAge.empty()
|
This structure is derived from FamilyMemberHistory
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| FamilyMemberHistory |
0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient | |
 implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| text |
0..0 | Text summary of the resource, for human interpretation | ||
| contained |
0..0 | Contained, inline Resources | ||
 extension |
0..0 | Extension | ||
 modifierExtension |
0..0 | Extension | ||
| instantiatesCanonical |
0..0 | Instantiates FHIR protocol or definition | ||
| instantiatesUri |
0..0 | Instantiates external protocol or definition | ||
| patient |
1..1 | Reference(Patient) | Patient history is about | |
| sex |
0..0 | male | female | other | unknown | ||
| born[x] |
0..0 | (approximate) date of birth | ||
| age[x] |
0..0 | (approximate) age | ||
| estimatedAge |
0..0 | Age is estimated? | ||
| deceased[x] |
0..0 | Dead? How old/when? | ||
| reasonCode |
0..0 | Why was family member history performed? | ||
| reasonReference |
0..0 | Why was family member history performed? | ||
| note |
0..0 | General note about related person | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| FamilyMemberHistory |
C | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient Constraints: fhs-1, fhs-2 |
| id |
Σ | 0..1 | id | Logical id of this artifact |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| identifier |
Σ | 0..* | Identifier | External Id(s) for this record |
| status |
?!Σ | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record. |
| dataAbsentReason |
Σ | 0..1 | CodeableConcept | 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..1 | Reference(Patient) | Patient history is about |
| date |
Σ | 0..1 | dateTime | When history was recorded or last updated |
| name |
Σ | 0..1 | string | The family member described |
| relationship |
Σ | 1..1 | CodeableConcept | 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. |
 condition |
0..* | BackboneElement | Condition that the related person had | |
 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 | Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis. | |
| outcome |
0..1 | CodeableConcept | 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..1 | boolean | Whether the condition contributed to the cause of death | |
  onset[x] |
0..1 | When condition first manifested | ||
 onsetAge |
Age | |||
| onsetRange |
Range | |||
| onsetPeriod |
Period | |||
| onsetString |
string | |||
| note |
0..* | Annotation | Extra information about condition | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| FamilyMemberHistory.status | Base | required | FamilyHistoryStatus | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.dataAbsentReason | Base | example | FamilyHistoryAbsentReason | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.relationship | Base | example | FamilyMember | 📦3.0.0 | THO v7.0 |
| FamilyMemberHistory.condition.code | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.condition.outcome | Base | example | Condition Outcome Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | FamilyMemberHistory | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | FamilyMemberHistory | 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-4 | error | FamilyMemberHistory | 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-5 | error | FamilyMemberHistory | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | FamilyMemberHistory | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| fhs-1 | error | FamilyMemberHistory | Can have age[x] or born[x], but not both |
age.empty() or born.empty()
|
| fhs-2 | error | FamilyMemberHistory | Can only have estimatedAge if age[x] is present |
age.exists() or estimatedAge.empty()
|
This structure is derived from FamilyMemberHistory
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| FamilyMemberHistory |
C | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient Constraints: fhs-1, fhs-2 |
| status |
?!Σ | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record. |
| patient |
Σ | 1..1 | Reference(Patient) | Patient history is about |
| relationship |
Σ | 1..1 | CodeableConcept | 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. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| FamilyMemberHistory.status | Base | required | FamilyHistoryStatus | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.relationship | Base | example | FamilyMember | 📦3.0.0 | THO v7.0 |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | FamilyMemberHistory | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | FamilyMemberHistory | 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-4 | error | FamilyMemberHistory | 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-5 | error | FamilyMemberHistory | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | FamilyMemberHistory | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| fhs-1 | error | FamilyMemberHistory | Can have age[x] or born[x], but not both |
age.empty() or born.empty()
|
| fhs-2 | error | FamilyMemberHistory | Can only have estimatedAge if age[x] is present |
age.exists() or estimatedAge.empty()
|
Differential View
This structure is derived from FamilyMemberHistory
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| FamilyMemberHistory |
0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient | |
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| text |
0..0 | Text summary of the resource, for human interpretation | ||
| contained |
0..0 | Contained, inline Resources | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| instantiatesCanonical |
0..0 | Instantiates FHIR protocol or definition | ||
| instantiatesUri |
0..0 | Instantiates external protocol or definition | ||
| patient |
1..1 | Reference(Patient) | Patient history is about | |
| sex |
0..0 | male | female | other | unknown | ||
| born[x] |
0..0 | (approximate) date of birth | ||
| age[x] |
0..0 | (approximate) age | ||
| estimatedAge |
0..0 | Age is estimated? | ||
| deceased[x] |
0..0 | Dead? How old/when? | ||
| reasonCode |
0..0 | Why was family member history performed? | ||
| reasonReference |
0..0 | Why was family member history performed? | ||
| note |
0..0 | General note about related person | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| FamilyMemberHistory |
C | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient Constraints: fhs-1, fhs-2 |
| id |
Σ | 0..1 | id | Logical id of this artifact |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| identifier |
Σ | 0..* | Identifier | External Id(s) for this record |
| status |
?!Σ | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record. |
| dataAbsentReason |
Σ | 0..1 | CodeableConcept | 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..1 | Reference(Patient) | Patient history is about |
| date |
Σ | 0..1 | dateTime | When history was recorded or last updated |
| name |
Σ | 0..1 | string | The family member described |
| relationship |
Σ | 1..1 | CodeableConcept | 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. |
| condition |
0..* | BackboneElement | Condition that the related person had | |
| 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 | Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis. | |
| outcome |
0..1 | CodeableConcept | 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..1 | boolean | Whether the condition contributed to the cause of death | |
| onset[x] |
0..1 | When condition first manifested | ||
| onsetAge |
Age | |||
| onsetRange |
Range | |||
| onsetPeriod |
Period | |||
| onsetString |
string | |||
| note |
0..* | Annotation | Extra information about condition | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| FamilyMemberHistory.status | Base | required | FamilyHistoryStatus | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.dataAbsentReason | Base | example | FamilyHistoryAbsentReason | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.relationship | Base | example | FamilyMember | 📦3.0.0 | THO v7.0 |
| FamilyMemberHistory.condition.code | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.condition.outcome | Base | example | Condition Outcome Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | FamilyMemberHistory | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | FamilyMemberHistory | 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-4 | error | FamilyMemberHistory | 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-5 | error | FamilyMemberHistory | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | FamilyMemberHistory | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| fhs-1 | error | FamilyMemberHistory | Can have age[x] or born[x], but not both |
age.empty() or born.empty()
|
| fhs-2 | error | FamilyMemberHistory | Can only have estimatedAge if age[x] is present |
age.exists() or estimatedAge.empty()
|
This structure is derived from FamilyMemberHistory
Other representations of profile: CSV, Excel, Schematron