This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Patient Care Work Group | Maturity Level: 1 | Compartments: Patient |
Significant health events and conditions for a person related to the patient relevant in the context of care for the patient.
This resource records significant health events and conditions for a particular individual related to the subject. This information can be known to different levels of accuracy. Sometimes the exact condition ('asthma') is known, and sometimes it is less precise ('some sort of cancer'). Equally, sometimes the person can be identified ('my aunt Agatha') and sometimes all that is known is that the person was an uncle.
This resource represents a simple structure used to capture an 'elementary' family history for a particular family member. However, it can also be the basis for capturing a more rigorous history useful for genetic and other analysis - refer to the Genetic Pedigree profile for an example.
The entire family history for an individual can be represented by combining references to FamilyMemberHistory instances into a List resource instance.
PLANNED CHANGE:
FamilyMemberHistory is one of the Event resources in the FHIR Workflow specification. As such, it is expected to be adjusted to align with the Event workflow pattern which will involve adding a number of additional data elements and potentially renaming a few elements. Any concerns about performing such alignment are welcome as ballot comments and/or tracker items.
This resource is referenced by clinicalimpression
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
FamilyMemberHistory | I | DomainResource | Information about patient's relatives, relevant for patient Can only have estimatedAge if age[x] is present Can have age[x] or born[x], but not both | |
identifier | 0..* | Identifier | External Id(s) for this record | |
patient | Σ | 1..1 | Reference(Patient) | Patient history is about |
date | Σ | 0..1 | dateTime | When history was captured/updated |
status | ?!Σ | 1..1 | code | partial | completed | entered-in-error | health-unknown FamilyHistoryStatus (Required) |
name | Σ | 0..1 | string | The family member described |
relationship | Σ | 1..1 | CodeableConcept | Relationship to the subject FamilyMember (Example) |
gender | Σ | 0..1 | code | male | female | other | unknown AdministrativeGender (Required) |
born[x] | I | 0..1 | (approximate) date of birth | |
bornPeriod | Period | |||
bornDate | date | |||
bornString | string | |||
age[x] | ΣI | 0..1 | (approximate) age | |
ageAge | Age | |||
ageRange | Range | |||
ageString | string | |||
estimatedAge | ?!ΣI | 0..1 | boolean | Age is estimated? |
deceased[x] | Σ | 0..1 | Dead? How old/when? | |
deceasedBoolean | boolean | |||
deceasedAge | Age | |||
deceasedRange | Range | |||
deceasedDate | date | |||
deceasedString | string | |||
note | 0..1 | Annotation | General note about related person | |
condition | 0..* | BackboneElement | Condition that the related person had | |
code | 1..1 | CodeableConcept | Condition suffered by relation Condition/Problem/Diagnosis Codes (Example) | |
outcome | 0..1 | CodeableConcept | deceased | permanent disability | etc. Condition Outcome Codes (Example) | |
onset[x] | 0..1 | When condition first manifested | ||
onsetAge | Age | |||
onsetRange | Range | |||
onsetPeriod | Period | |||
onsetString | string | |||
note | 0..1 | Annotation | Extra information about condition | |
Documentation for this format |
UML Diagram (Legend)
XML Template
<FamilyMemberHistory xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier External Id(s) for this record --></identifier> <patient><!-- 1..1 Reference(Patient) Patient history is about --></patient> <date value="[dateTime]"/><!-- 0..1 When history was captured/updated --> <status value="[code]"/><!-- 1..1 partial | completed | entered-in-error | health-unknown --> <name value="[string]"/><!-- 0..1 The family member described --> <relationship><!-- 1..1 CodeableConcept Relationship to the subject --></relationship> <gender value="[code]"/><!-- 0..1 male | female | other | unknown --> <born[x]><!-- 0..1 Period|date|string (approximate) date of birth --></born[x]> <age[x]><!-- 0..1 Age|Range|string (approximate) age --></age[x]> <estimatedAge value="[boolean]"/><!-- 0..1 Age is estimated? --> <deceased[x]><!-- 0..1 boolean|Age|Range|date|string Dead? How old/when? --></deceased[x]> <note><!-- 0..1 Annotation General note about related person --></note> <condition> <!-- 0..* Condition that the related person had --> <code><!-- 1..1 CodeableConcept Condition suffered by relation --></code> <outcome><!-- 0..1 CodeableConcept deceased | permanent disability | etc. --></outcome> <onset[x]><!-- 0..1 Age|Range|Period|string When condition first manifested --></onset[x]> <note><!-- 0..1 Annotation Extra information about condition --></note> </condition> </FamilyMemberHistory>
JSON Template
{ "resourceType" : "FamilyMemberHistory", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // External Id(s) for this record "patient" : { Reference(Patient) }, // R! Patient history is about "date" : "<dateTime>", // When history was captured/updated "status" : "<code>", // R! partial | completed | entered-in-error | health-unknown "name" : "<string>", // The family member described "relationship" : { CodeableConcept }, // R! Relationship to the subject "gender" : "<code>", // male | female | other | unknown // born[x]: (approximate) date of birth. One of these 3: "bornPeriod" : { Period }, "bornDate" : "<date>", "bornString" : "<string>", // age[x]: (approximate) age. One of these 3: "ageAge" : { Age }, "ageRange" : { Range }, "ageString" : "<string>", "estimatedAge" : <boolean>, // C? Age is estimated? // deceased[x]: Dead? How old/when?. One of these 5: "deceasedBoolean" : <boolean>, "deceasedAge" : { Age }, "deceasedRange" : { Range }, "deceasedDate" : "<date>", "deceasedString" : "<string>", "note" : { Annotation }, // General note about related person "condition" : [{ // Condition that the related person had "code" : { CodeableConcept }, // R! Condition suffered by relation "outcome" : { CodeableConcept }, // deceased | permanent disability | etc. // onset[x]: When condition first manifested. One of these 4: "onsetAge" : { Age }, "onsetRange" : { Range }, "onsetPeriod" : { Period }, "onsetString" : "<string>", "note" : { Annotation } // Extra information about condition }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:FamilyMemberHistory; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:FamilyMemberHistory.identifier [ Identifier ], ... ; # 0..* External Id(s) for this record fhir:FamilyMemberHistory.patient [ Reference(Patient) ]; # 1..1 Patient history is about fhir:FamilyMemberHistory.date [ dateTime ]; # 0..1 When history was captured/updated fhir:FamilyMemberHistory.status [ code ]; # 1..1 partial | completed | entered-in-error | health-unknown fhir:FamilyMemberHistory.name [ string ]; # 0..1 The family member described fhir:FamilyMemberHistory.relationship [ CodeableConcept ]; # 1..1 Relationship to the subject fhir:FamilyMemberHistory.gender [ code ]; # 0..1 male | female | other | unknown # FamilyMemberHistory.born[x] : 0..1 (approximate) date of birth. One of these 3 fhir:FamilyMemberHistory.bornPeriod [ Period ] fhir:FamilyMemberHistory.bornDate [ date ] fhir:FamilyMemberHistory.bornString [ string ] # FamilyMemberHistory.age[x] : 0..1 (approximate) age. One of these 3 fhir:FamilyMemberHistory.ageAge [ Age ] fhir:FamilyMemberHistory.ageRange [ Range ] fhir:FamilyMemberHistory.ageString [ string ] fhir:FamilyMemberHistory.estimatedAge [ boolean ]; # 0..1 Age is estimated? # FamilyMemberHistory.deceased[x] : 0..1 Dead? How old/when?. One of these 5 fhir:FamilyMemberHistory.deceasedBoolean [ boolean ] fhir:FamilyMemberHistory.deceasedAge [ Age ] fhir:FamilyMemberHistory.deceasedRange [ Range ] fhir:FamilyMemberHistory.deceasedDate [ date ] fhir:FamilyMemberHistory.deceasedString [ string ] fhir:FamilyMemberHistory.note [ Annotation ]; # 0..1 General note about related person fhir:FamilyMemberHistory.condition [ # 0..* Condition that the related person had fhir:FamilyMemberHistory.condition.code [ CodeableConcept ]; # 1..1 Condition suffered by relation fhir:FamilyMemberHistory.condition.outcome [ CodeableConcept ]; # 0..1 deceased | permanent disability | etc. # FamilyMemberHistory.condition.onset[x] : 0..1 When condition first manifested. One of these 4 fhir:FamilyMemberHistory.condition.onsetAge [ Age ] fhir:FamilyMemberHistory.condition.onsetRange [ Range ] fhir:FamilyMemberHistory.condition.onsetPeriod [ Period ] fhir:FamilyMemberHistory.condition.onsetString [ string ] fhir:FamilyMemberHistory.condition.note [ Annotation ]; # 0..1 Extra information about condition ], ...; ]
Changes since DSTU2
FamilyMemberHistory | |
FamilyMemberHistory.age[x] | Remove Quantity{http://hl7.org/fhir/StructureDefinition/Age}, Add Age |
FamilyMemberHistory.estimatedAge | added Element |
FamilyMemberHistory.deceased[x] | Remove Quantity{http://hl7.org/fhir/StructureDefinition/Age}, Add Age |
FamilyMemberHistory.condition.onset[x] | Remove Quantity{http://hl7.org/fhir/StructureDefinition/Age}, Add Age |
See the Full Difference for further information
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
FamilyMemberHistory | I | DomainResource | Information about patient's relatives, relevant for patient Can only have estimatedAge if age[x] is present Can have age[x] or born[x], but not both | |
identifier | 0..* | Identifier | External Id(s) for this record | |
patient | Σ | 1..1 | Reference(Patient) | Patient history is about |
date | Σ | 0..1 | dateTime | When history was captured/updated |
status | ?!Σ | 1..1 | code | partial | completed | entered-in-error | health-unknown FamilyHistoryStatus (Required) |
name | Σ | 0..1 | string | The family member described |
relationship | Σ | 1..1 | CodeableConcept | Relationship to the subject FamilyMember (Example) |
gender | Σ | 0..1 | code | male | female | other | unknown AdministrativeGender (Required) |
born[x] | I | 0..1 | (approximate) date of birth | |
bornPeriod | Period | |||
bornDate | date | |||
bornString | string | |||
age[x] | ΣI | 0..1 | (approximate) age | |
ageAge | Age | |||
ageRange | Range | |||
ageString | string | |||
estimatedAge | ?!ΣI | 0..1 | boolean | Age is estimated? |
deceased[x] | Σ | 0..1 | Dead? How old/when? | |
deceasedBoolean | boolean | |||
deceasedAge | Age | |||
deceasedRange | Range | |||
deceasedDate | date | |||
deceasedString | string | |||
note | 0..1 | Annotation | General note about related person | |
condition | 0..* | BackboneElement | Condition that the related person had | |
code | 1..1 | CodeableConcept | Condition suffered by relation Condition/Problem/Diagnosis Codes (Example) | |
outcome | 0..1 | CodeableConcept | deceased | permanent disability | etc. Condition Outcome Codes (Example) | |
onset[x] | 0..1 | When condition first manifested | ||
onsetAge | Age | |||
onsetRange | Range | |||
onsetPeriod | Period | |||
onsetString | string | |||
note | 0..1 | Annotation | Extra information about condition | |
Documentation for this format |
XML Template
<FamilyMemberHistory xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier External Id(s) for this record --></identifier> <patient><!-- 1..1 Reference(Patient) Patient history is about --></patient> <date value="[dateTime]"/><!-- 0..1 When history was captured/updated --> <status value="[code]"/><!-- 1..1 partial | completed | entered-in-error | health-unknown --> <name value="[string]"/><!-- 0..1 The family member described --> <relationship><!-- 1..1 CodeableConcept Relationship to the subject --></relationship> <gender value="[code]"/><!-- 0..1 male | female | other | unknown --> <born[x]><!-- 0..1 Period|date|string (approximate) date of birth --></born[x]> <age[x]><!-- 0..1 Age|Range|string (approximate) age --></age[x]> <estimatedAge value="[boolean]"/><!-- 0..1 Age is estimated? --> <deceased[x]><!-- 0..1 boolean|Age|Range|date|string Dead? How old/when? --></deceased[x]> <note><!-- 0..1 Annotation General note about related person --></note> <condition> <!-- 0..* Condition that the related person had --> <code><!-- 1..1 CodeableConcept Condition suffered by relation --></code> <outcome><!-- 0..1 CodeableConcept deceased | permanent disability | etc. --></outcome> <onset[x]><!-- 0..1 Age|Range|Period|string When condition first manifested --></onset[x]> <note><!-- 0..1 Annotation Extra information about condition --></note> </condition> </FamilyMemberHistory>
JSON Template
{ "resourceType" : "FamilyMemberHistory", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // External Id(s) for this record "patient" : { Reference(Patient) }, // R! Patient history is about "date" : "<dateTime>", // When history was captured/updated "status" : "<code>", // R! partial | completed | entered-in-error | health-unknown "name" : "<string>", // The family member described "relationship" : { CodeableConcept }, // R! Relationship to the subject "gender" : "<code>", // male | female | other | unknown // born[x]: (approximate) date of birth. One of these 3: "bornPeriod" : { Period }, "bornDate" : "<date>", "bornString" : "<string>", // age[x]: (approximate) age. One of these 3: "ageAge" : { Age }, "ageRange" : { Range }, "ageString" : "<string>", "estimatedAge" : <boolean>, // C? Age is estimated? // deceased[x]: Dead? How old/when?. One of these 5: "deceasedBoolean" : <boolean>, "deceasedAge" : { Age }, "deceasedRange" : { Range }, "deceasedDate" : "<date>", "deceasedString" : "<string>", "note" : { Annotation }, // General note about related person "condition" : [{ // Condition that the related person had "code" : { CodeableConcept }, // R! Condition suffered by relation "outcome" : { CodeableConcept }, // deceased | permanent disability | etc. // onset[x]: When condition first manifested. One of these 4: "onsetAge" : { Age }, "onsetRange" : { Range }, "onsetPeriod" : { Period }, "onsetString" : "<string>", "note" : { Annotation } // Extra information about condition }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:FamilyMemberHistory; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:FamilyMemberHistory.identifier [ Identifier ], ... ; # 0..* External Id(s) for this record fhir:FamilyMemberHistory.patient [ Reference(Patient) ]; # 1..1 Patient history is about fhir:FamilyMemberHistory.date [ dateTime ]; # 0..1 When history was captured/updated fhir:FamilyMemberHistory.status [ code ]; # 1..1 partial | completed | entered-in-error | health-unknown fhir:FamilyMemberHistory.name [ string ]; # 0..1 The family member described fhir:FamilyMemberHistory.relationship [ CodeableConcept ]; # 1..1 Relationship to the subject fhir:FamilyMemberHistory.gender [ code ]; # 0..1 male | female | other | unknown # FamilyMemberHistory.born[x] : 0..1 (approximate) date of birth. One of these 3 fhir:FamilyMemberHistory.bornPeriod [ Period ] fhir:FamilyMemberHistory.bornDate [ date ] fhir:FamilyMemberHistory.bornString [ string ] # FamilyMemberHistory.age[x] : 0..1 (approximate) age. One of these 3 fhir:FamilyMemberHistory.ageAge [ Age ] fhir:FamilyMemberHistory.ageRange [ Range ] fhir:FamilyMemberHistory.ageString [ string ] fhir:FamilyMemberHistory.estimatedAge [ boolean ]; # 0..1 Age is estimated? # FamilyMemberHistory.deceased[x] : 0..1 Dead? How old/when?. One of these 5 fhir:FamilyMemberHistory.deceasedBoolean [ boolean ] fhir:FamilyMemberHistory.deceasedAge [ Age ] fhir:FamilyMemberHistory.deceasedRange [ Range ] fhir:FamilyMemberHistory.deceasedDate [ date ] fhir:FamilyMemberHistory.deceasedString [ string ] fhir:FamilyMemberHistory.note [ Annotation ]; # 0..1 General note about related person fhir:FamilyMemberHistory.condition [ # 0..* Condition that the related person had fhir:FamilyMemberHistory.condition.code [ CodeableConcept ]; # 1..1 Condition suffered by relation fhir:FamilyMemberHistory.condition.outcome [ CodeableConcept ]; # 0..1 deceased | permanent disability | etc. # FamilyMemberHistory.condition.onset[x] : 0..1 When condition first manifested. One of these 4 fhir:FamilyMemberHistory.condition.onsetAge [ Age ] fhir:FamilyMemberHistory.condition.onsetRange [ Range ] fhir:FamilyMemberHistory.condition.onsetPeriod [ Period ] fhir:FamilyMemberHistory.condition.onsetString [ string ] fhir:FamilyMemberHistory.condition.note [ Annotation ]; # 0..1 Extra information about condition ], ...; ]
Changes since DSTU2
FamilyMemberHistory | |
FamilyMemberHistory.age[x] | Remove Quantity{http://hl7.org/fhir/StructureDefinition/Age}, Add Age |
FamilyMemberHistory.estimatedAge | added Element |
FamilyMemberHistory.deceased[x] | Remove Quantity{http://hl7.org/fhir/StructureDefinition/Age}, Add Age |
FamilyMemberHistory.condition.onset[x] | Remove Quantity{http://hl7.org/fhir/StructureDefinition/Age}, Add Age |
See the Full Difference for further information
Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle), JSON-LD (for RDF as JSON-LD),
Path | Definition | Type | Reference |
---|---|---|---|
FamilyMemberHistory.status | A code that identifies the status of the family history record. | Required | FamilyHistoryStatus |
FamilyMemberHistory.relationship | The nature of the relationship between the patient and the related person being described in the family member history. | Example | FamilyMember |
FamilyMemberHistory.gender | The gender of a person used for administrative purposes. | Required | AdministrativeGender |
FamilyMemberHistory.condition.code | Identification of the Condition or diagnosis. | Example | Condition/Problem/Diagnosis Codes |
FamilyMemberHistory.condition.outcome | The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc. | Example | Condition Outcome Codes |
The Family Member History List may contain other than FamilyMemberHistory resources. For example, a full Family History could be a List that might include a mixture of FamilyMemberHistory records as well as Observation records of things like "maternal family history of breast cancer", "number of siblings", "number of female family members with breast cancer" etc.
The List representing a patient's "family history" can include Condition and Observation records that capture "family-history" relevant assertions about the patient themselves that would typically be captured as part of a family history.
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Paths | In Common |
code | token | A search by a condition code | FamilyMemberHistory.condition.code | 8 Resources |
date | date | When history was captured/updated | FamilyMemberHistory.date | 18 Resources |
gender | token | A search by a gender code of a family member | FamilyMemberHistory.gender | |
identifier | token | A search by a record identifier | FamilyMemberHistory.identifier | 26 Resources |
patient | reference | The identity of a subject to list family member history items for | FamilyMemberHistory.patient (Patient) | 31 Resources |
relationship | token | A search by a relationship type | FamilyMemberHistory.relationship |