This page is part of the FHIR Specification (v1.4.0:
STU
3 Ballot 3). The current version which supercedes this version is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
. For a full list of available versions, see the
Directory of published versions
.
Page
versions:
. Page versions:
R5
R4B
R4
R3
R2
|
|
Compartments
|
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
instances into a
List
resource
instance.
This
resource
is
referenced
by
resource instance.
This resource is referenced by clinicalimpression
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
I | DomainResource |
|
|
|
0..* | Identifier |
|
|
|
Σ | 1..1 | Reference ( Patient ) |
|
|
Σ | 0..1 | dateTime |
|
|
|
1..1 | code |
FamilyHistoryStatus |
|
Σ | 0..1 | string |
|
|
Σ | 1..1 | CodeableConcept |
FamilyMember |
|
Σ | 0..1 | code |
AdministrativeGender |
|
I | 0..1 |
|
|
|
Period | |||
|
date | |||
|
string | |||
|
I | 0..1 |
|
|
|
Age | |||
|
Range | |||
|
string | |||
|
0..1 |
|
||
|
boolean | |||
|
Age | |||
|
Range | |||
|
date | |||
|
string | |||
|
0..1 | Annotation |
|
|
|
0..* | BackboneElement |
|
|
|
1..1 | CodeableConcept |
|
|
|
0..1 | CodeableConcept |
|
|
|
0..1 |
|
||
|
Age | |||
|
Range | |||
|
Period | |||
|
string | |||
|
0..1 | Annotation |
|
|
Documentation for this format
|
||||
UML
Diagram
UML Diagram
XML
Template
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><relationship><!-- 1..1 CodeableConcept Relationship to the subject --></relationship> <gender value="[code]"/><!-- 0..1 male | female | other | unknown --><</born[x]> <</age[x]><born[x]><!--0..1 Period|date|string (approximate) date of birth --></born[x]> <age[x]><!--
0..1 Quantity(Age)|Range|string (approximate) age --></age[x]> <deceased[x]><!-- 0..1 boolean|Quantity(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 Quantity(Age)|Range|Period|string When condition first manifested --></onset[x]> <note><!-- 0..1 Annotation Extra information about condition --></note> </condition> </FamilyMemberHistory>
JSON
Template
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:
"ageQuantity" : { Quantity(Age) },
"ageRange" : { Range },
"ageString" : "<string>",
// deceased[x]: Dead? How old/when?. One of these 5:
"deceasedBoolean" : <boolean>,
"deceasedQuantity" : { Quantity(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:
"onsetQuantity" : { Quantity(Age) },
"onsetRange" : { Range },
"onsetPeriod" : { Period },
"onsetString" : "<string>",
"note" : { Annotation } // Extra information about condition
}]
}
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
I | DomainResource |
|
|
|
0..* | Identifier |
|
|
|
Σ | 1..1 | Reference ( Patient ) |
|
|
Σ | 0..1 | dateTime |
|
|
|
1..1 | code |
FamilyHistoryStatus |
|
Σ | 0..1 | string |
|
|
Σ | 1..1 | CodeableConcept |
FamilyMember |
|
Σ | 0..1 | code |
AdministrativeGender |
|
I | 0..1 |
|
|
|
Period | |||
|
date | |||
|
string | |||
|
I | 0..1 |
|
|
|
Age | |||
|
Range | |||
|
string | |||
|
0..1 |
|
||
|
boolean | |||
|
Age | |||
|
Range | |||
|
date | |||
|
string | |||
|
0..1 | Annotation |
|
|
|
0..* | BackboneElement |
|
|
|
1..1 | CodeableConcept |
|
|
|
0..1 | CodeableConcept |
|
|
|
0..1 |
|
||
|
Age | |||
|
Range | |||
|
Period | |||
|
string | |||
|
0..1 | Annotation |
|
|
Documentation for this format
|
||||
XML
Template
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><relationship><!-- 1..1 CodeableConcept Relationship to the subject --></relationship> <gender value="[code]"/><!-- 0..1 male | female | other | unknown --><</born[x]> <</age[x]><born[x]><!--0..1 Period|date|string (approximate) date of birth --></born[x]> <age[x]><!--
0..1 Quantity(Age)|Range|string (approximate) age --></age[x]> <deceased[x]><!-- 0..1 boolean|Quantity(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 Quantity(Age)|Range|Period|string When condition first manifested --></onset[x]> <note><!-- 0..1 Annotation Extra information about condition --></note> </condition> </FamilyMemberHistory>
JSON
Template
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:
"ageQuantity" : { Quantity(Age) },
"ageRange" : { Range },
"ageString" : "<string>",
// deceased[x]: Dead? How old/when?. One of these 5:
"deceasedBoolean" : <boolean>,
"deceasedQuantity" : { Quantity(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:
"onsetQuantity" : { Quantity(Age) },
"onsetRange" : { Range },
"onsetPeriod" : { Period },
"onsetString" : "<string>",
"note" : { Annotation } // Extra information about condition
}]
}
Alternate
definitions:
Alternate definitions:
Schema
/
Schematron
,
Resource
Profile
(
, Resource Profile (
XML
,
,
JSON
),
),
Questionnaire
| Path | Definition | Type | Reference |
|---|---|---|---|
|
|
|
Required | FamilyHistoryStatus |
|
|
|
Example | FamilyMember |
|
|
|
Required | AdministrativeGender |
|
|
|
Example |
|
|
|
|
Example |
|
The Family Member History
List
may
contain
other
than
FamilyMemberHistory
resources.
For
example,
a
full
Family
History
could
be
a
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
that might include a mixture of FamilyMemberHistory records as well as
Observation
records
of
things
like
"maternal
family
history
of
breast
cancer".
records of things like "maternal family history of breast cancer".
Search parameters for this resource. The
common parameters
also apply. See
Searching
for
more
information
about
searching
in
REST,
messaging,
and
services.
for more information about searching in REST, messaging, and services.
| Name | Type | Description | Paths |
| code | token |
|
FamilyMemberHistory.condition.code |
| date | date |
|
FamilyMemberHistory.date |
| gender | token |
|
FamilyMemberHistory.gender |
| identifier | token |
|
FamilyMemberHistory.identifier |
| patient | reference |
|
FamilyMemberHistory.patient
( Patient ) |
| relationship | token |
|
FamilyMemberHistory.relationship |