Athena Core Implementation Guide
5.5.0 - release

Athena Core Implementation Guide - Local Development build (v5.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: athenahealth FamilyMemberHistory

Official URL: https://fhir.athena.io/StructureDefinition/ah-familymemberhistory Version: 5.5.0
Active as of 2025-11-13 Computable Name: AthenahealthFamilyMemberHistory
Keywords: Wire Format

The FamilyMemberHistory records significant health conditions for a particular individual related to the subject.

This data source will fetch the family member history data for the given patient or id.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from FamilyMemberHistory

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
... id 1..1 id Logical id of this artifact
... meta
.... lastUpdated 0..1 instant When the resource version last changed
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
... sex 1..1 CodeableConcept male | female | other | unknown

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
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
fhs-1: Can have age[x] or born[x], but not both
fhs-2: Can only have estimatedAge if age[x] is present
... id Σ 1..1 id Logical id of this artifact
... 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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
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 partial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.


ele-1: All FHIR elements must have a @value or children
... patient Σ 1..1 Reference(Patient) Patient history is about
ele-1: All FHIR elements must have a @value or children
... date Σ 1..1 dateTime When history was recorded or last updated
ele-1: All FHIR elements must have a @value or children
... 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.


ele-1: All FHIR elements must have a @value or children
... sex Σ 1..1 CodeableConcept male | female | other | unknown
Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
FamilyMemberHistory.statusrequiredFamilyHistoryStatus
http://hl7.org/fhir/ValueSet/history-status|4.0.1
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
NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
fhs-1: Can have age[x] or born[x], but not both
fhs-2: Can only have estimatedAge if age[x] is present
... id Σ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
... 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 Σ 1..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 Σ 1..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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
FamilyMemberHistory.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
FamilyMemberHistory.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
FamilyMemberHistory.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
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

This structure is derived from FamilyMemberHistory

Summary

Mandatory: 5 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from FamilyMemberHistory

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
... id 1..1 id Logical id of this artifact
... meta
.... lastUpdated 0..1 instant When the resource version last changed
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
... sex 1..1 CodeableConcept male | female | other | unknown

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
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
fhs-1: Can have age[x] or born[x], but not both
fhs-2: Can only have estimatedAge if age[x] is present
... id Σ 1..1 id Logical id of this artifact
... 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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
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 partial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.


ele-1: All FHIR elements must have a @value or children
... patient Σ 1..1 Reference(Patient) Patient history is about
ele-1: All FHIR elements must have a @value or children
... date Σ 1..1 dateTime When history was recorded or last updated
ele-1: All FHIR elements must have a @value or children
... 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.


ele-1: All FHIR elements must have a @value or children
... sex Σ 1..1 CodeableConcept male | female | other | unknown
Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
FamilyMemberHistory.statusrequiredFamilyHistoryStatus
http://hl7.org/fhir/ValueSet/history-status|4.0.1
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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
fhs-1: Can have age[x] or born[x], but not both
fhs-2: Can only have estimatedAge if age[x] is present
... id Σ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
... 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 Σ 1..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 Σ 1..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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
FamilyMemberHistory.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
FamilyMemberHistory.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
FamilyMemberHistory.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
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

This structure is derived from FamilyMemberHistory

Summary

Mandatory: 5 elements

Extensions

This structure refers to these extensions:

 

​Other representations of profile: CSV, Excel, Schematron