haau3 FHIR Implementation Guide (HFIG)
1.0.0 - ci-build
haau3 FHIR Implementation Guide (HFIG)
1.0.0 - ci-build
haau3 FHIR Implementation Guide (HFIG) - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://haau3.com/fhir/StructureDefinition/haau3-family-member-history | Version: 1.0.0 | |||
| Draft as of 2026-10-14 | Computable Name: Haau3FamilyMemberHistory | |||
A relative's health history as the source system recorded it — which relative, and what they were diagnosed with. Delivered exactly as it arrived: relationships are properly coded, conditions carry coded diagnoses, and no age or birth date for the relative is sent. Nothing here is derived by haau3.
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 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 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. | |
 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. | |
 condition |
0..* | BackboneElement | Condition that the related person had | |
 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. | |
| 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.4 |
| FamilyMemberHistory.condition.code | Base | example | Condition/Problem/Diagnosis 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| FamilyMemberHistory |
0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient | |
 identifier |
0..* | Identifier | External Id(s) for this record | |
| patient |
1..1 | Reference(Patient) | Patient history is about | |
| relationship |
1..1 | CodeableConcept | Relationship to the subject | |
| condition |
0..* | BackboneElement | Condition that the related person had | |
| 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 | |||||
| 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): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| 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 | External Id(s) for this record | |||||
| instantiatesCanonical |
0..* | canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |||||
| instantiatesUri |
0..* | uri | Instantiates external protocol or definition | |||||
| 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. | |||||
| sex |
0..1 | CodeableConcept | male | female | other | unknown Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration. | |||||
  born[x] |
C | 0..1 | (approximate) date of birth | |||||
 bornPeriod |
Period | |||||||
| bornDate |
date | |||||||
| bornString |
string | |||||||
| age[x] |
C | 0..1 | (approximate) age | |||||
| ageAge |
Age | |||||||
| ageRange |
Range | |||||||
| ageString |
string | |||||||
| estimatedAge |
C | 0..1 | boolean | Age is estimated? | ||||
| deceased[x] |
0..1 | Dead? How old/when? | ||||||
| deceasedBoolean |
boolean | |||||||
| deceasedAge |
Age | |||||||
| deceasedRange |
Range | |||||||
| deceasedDate |
date | |||||||
| deceasedString |
string | |||||||
| reasonCode |
0..* | CodeableConcept | Why was family member history performed? Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done. | |||||
| reasonReference |
0..* | Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) | 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..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.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| 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.4 |
| FamilyMemberHistory.sex | Base | extensible | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.reasonCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| 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 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| 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. | |
| 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. | |
| condition |
0..* | BackboneElement | Condition that the related person had | |
| 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. | |
| 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.4 |
| FamilyMemberHistory.condition.code | Base | example | Condition/Problem/Diagnosis 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()
|
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 | |
| identifier |
0..* | Identifier | External Id(s) for this record | |
| patient |
1..1 | Reference(Patient) | Patient history is about | |
| relationship |
1..1 | CodeableConcept | Relationship to the subject | |
| condition |
0..* | BackboneElement | Condition that the related person had | |
| 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 | |||||
| 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): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| 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 | External Id(s) for this record | |||||
| instantiatesCanonical |
0..* | canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |||||
| instantiatesUri |
0..* | uri | Instantiates external protocol or definition | |||||
| 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. | |||||
| sex |
0..1 | CodeableConcept | male | female | other | unknown Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration. | |||||
| born[x] |
C | 0..1 | (approximate) date of birth | |||||
| bornPeriod |
Period | |||||||
| bornDate |
date | |||||||
| bornString |
string | |||||||
| age[x] |
C | 0..1 | (approximate) age | |||||
| ageAge |
Age | |||||||
| ageRange |
Range | |||||||
| ageString |
string | |||||||
| estimatedAge |
C | 0..1 | boolean | Age is estimated? | ||||
| deceased[x] |
0..1 | Dead? How old/when? | ||||||
| deceasedBoolean |
boolean | |||||||
| deceasedAge |
Age | |||||||
| deceasedRange |
Range | |||||||
| deceasedDate |
date | |||||||
| deceasedString |
string | |||||||
| reasonCode |
0..* | CodeableConcept | Why was family member history performed? Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done. | |||||
| reasonReference |
0..* | Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) | 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..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.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| 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.4 |
| FamilyMemberHistory.sex | Base | extensible | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| FamilyMemberHistory.reasonCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| 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