This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
Responsible
Owner:
Patient
Care
Work
Group
|
|
Security Category : Patient | Compartments : Patient |
Significant health conditions for a person related to the patient relevant in the context of care for the patient.
FamilyMemberHistory is one of the event resources in the FHIR workflow specification.
This resource records significant health 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.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
|
|
DomainResource |
Information
about
patient's
relatives,
relevant
for
patient
+ Rule: Can have age[x] or born[x], but not both + Rule: Can only have estimatedAge if age[x] is present + Rule: Can have age[x] or deceased[x], but not both Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
External
Id(s)
for
this
record
|
|
?! Σ | 1..1 |
|
partial
|
Binding: Family History Status |
|
Σ | 0..1 |
|
subject-unknown
|
withheld
|
unable-to-obtain
|
deferred
Binding: Family History Absent Reason ( Example ) |
|
|
1..1 |
|
Patient
history
is
about
|
|
Σ | 0..1 |
|
When
history
was
recorded
or
last
updated
|
|
Σ | 0..1 | Reference ( Practitioner | PractitionerRole | Patient | RelatedPerson | Organization | CareTeam | Group ) |
Who
recorded
the
family
member
history
|
|
Σ | 0..1 |
|
Person
or
|
|
Σ | 0..1 | string |
The
family
member
described
|
|
Σ | 1..1 | CodeableConcept |
Relationship
to
the
subject
Binding: FamilyMember
|
|
Σ | 0..1 | CodeableConcept |
male
|
female
|
other
|
unknown
Binding: AdministrativeGender ( Extensible ) |
|
|
0..1 |
(approximate)
date
of
birth
|
|
|
Period | |||
|
date | |||
|
string | |||
|
Σ
|
0..1 |
(approximate)
age
|
|
|
Age | |||
|
Range | |||
|
string | |||
|
Σ
|
0..1 | boolean |
Age
is
estimated?
|
|
Σ C | 0..1 |
Dead?
How
old/when?
|
|
|
boolean | |||
|
Age | |||
|
Range | |||
|
date | |||
|
string | |||
|
Σ | 0..* |
|
Why
was
family
member
history
performed?
Binding: SNOMED CT Clinical Findings ( Example ) |
|
0..* | Annotation |
General
note
about
related
person
|
|
|
Σ | 0..* | BackboneElement |
Condition
that
the
related
person
had
|
|
Σ | 1..1 | CodeableConcept |
Condition,
allergy,
or
intolerance
suffered
by
relation
Binding: Condition/Problem/Diagnosis Codes ( Example ) |
|
0..1 | CodeableConcept |
deceased
|
permanent
disability
|
Binding: Condition Outcome Codes ( Example ) |
|
|
0..1 | boolean |
Whether
the
condition
contributed
to
the
cause
of
death
|
|
|
0..1 |
When
condition
first
manifested
|
||
|
Age | |||
|
Range | |||
| Period | |||
| string | |||
| 0..* | Annotation |
Extra
information
about
condition
| |
![]() ![]() | 0..* | BackboneElement |
Procedures
that
the
related
person
had
| |
![]() ![]() ![]() | 1..1 | CodeableConcept |
Procedures
performed
on
the
related
person
Binding: Procedure Codes (SNOMED CT) ( Example ) | |
![]() ![]() ![]() | 0..1 | CodeableConcept |
What
happened
following
the
procedure
Binding: SNOMED CT Clinical Findings ( Example ) | |
![]() ![]() ![]() | 0..1 | boolean |
Whether
the
procedure
contributed
to
the
cause
of
death
| |
![]() ![]() ![]() | 0..1 |
When
the
procedure
was
performed
| ||
![]() ![]() ![]() ![]() | Age | |||
|
Range | |||
| Period | |||
|
string | |||
| dateTime | |||
|
0..* | Annotation |
Extra
information
about
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
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>
<| </instantiatesCanonical> <<status value="[code]"/><!-- 1..1 partial | completed | entered-in-error | health-unknown --> <dataAbsentReason><!-- 0..1 CodeableConcept subject-unknown | withheld | unable-to-obtain | deferred --></dataAbsentReason> <patient><!-- 1..1 Reference(Patient) Patient history is about --></patient> <date value="[dateTime]"/><!-- 0..1 When history was recorded or last updated --> <recorder><!-- 0..1 Reference(CareTeam|Group|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) Who recorded the family member history --></recorder> <asserter><!-- 0..1 Reference(CareTeam|Device|Group|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson) Person or device that asserts this family member history --></asserter> <name value="[string]"/><!-- 0..1 The family member described --><</relationship><relationship><!-- 1..1 CodeableConcept Relationship to the subject--></relationship> <sex><!-- 0..1 CodeableConcept male | female | other | unknown --></sex>
<</born[x]> <</age[x]> < <</deceased[x]> <</reasonCode> <| </reasonReference><born[x]><!-- I 0..1 Period|date|string (approximate) date of birth --></born[x]> <age[x]><!-- I 0..1 Age|Range|string (approximate) age --></age[x]> <estimatedAge value="[boolean]"/><!-- I 0..1 Age is estimated? --> <deceased[x]><!-- I 0..1 boolean|Age|Range|date|string Dead? How old/when? --></deceased[x]> <reason><!-- 0..* CodeableReference(AllergyIntolerance|Condition| DiagnosticReport|DocumentReference|Observation|QuestionnaireResponse) Why was family member history performed? --></reason> <note><!-- 0..* Annotation General note about related person --></note> <condition> <!-- 0..* Condition that the related person had --><</code> <</outcome><code><!-- 1..1 CodeableConcept Condition, allergy, or intolerance suffered by relation --></code> <outcome><!-- 0..1 CodeableConcept deceased | permanent disability | etc --></outcome> <contributedToDeath value="[boolean]"/><!-- 0..1 Whether the condition contributed to the cause of death --> <onset[x]><!-- 0..1 Age|Range|Period|string When condition first manifested --></onset[x]> <note><!-- 0..* Annotation Extra information about condition --></note> </condition> <procedure> <!-- 0..* Procedures that the related person had --> <code><!-- 1..1 CodeableConcept Procedures performed on the related person --></code> <outcome><!-- 0..1 CodeableConcept What happened following the procedure --></outcome> <contributedToDeath value="[boolean]"/><!-- 0..1 Whether the procedure contributed to the cause of death --> <performed[x]><!-- 0..1 Age|Range|Period|string|dateTime When the procedure was performed --></performed[x]> <note><!-- 0..* Annotation Extra information about the procedure --></note> </procedure> </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
"|
"
"status" : "<code>", // R! partial | completed | entered-in-error | health-unknown
"dataAbsentReason" : { CodeableConcept }, // subject-unknown | withheld | unable-to-obtain | deferred
"patient" : { Reference(Patient) }, // R! Patient history is about
"date" : "<dateTime>", // When history was recorded or last updated
"recorder" : { Reference(CareTeam|Group|Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson) }, // Who recorded the family member history
"asserter" : { Reference(CareTeam|Device|Group|Organization|Patient|
Practitioner|PractitionerRole|RelatedPerson) }, // Person or device that asserts this family member history
"name" : "<string>", // The family member described
"
"relationship" : { CodeableConcept }, // R! Relationship to the subject
"sex" : { CodeableConcept }, // 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>, // I Age is estimated?
// deceased[x]: Dead? How old/when?. One of these 5:
"deceasedBoolean" : <boolean>,
"deceasedAge" : { Age },
"deceasedRange" : { Range },
"deceasedDate" : "<date>",
"deceasedString" : "<string>",
"
"|
"reason" : [{ CodeableReference(AllergyIntolerance|Condition|
DiagnosticReport|DocumentReference|Observation|QuestionnaireResponse) }], // Why was family member history performed?
"note" : [{ Annotation }], // General note about related person
"condition" : [{ // Condition that the related person had
"
"
"code" : { CodeableConcept }, // R! Condition, allergy, or intolerance suffered by relation
"outcome" : { CodeableConcept }, // deceased | permanent disability | etc
"contributedToDeath" : <boolean>, // Whether the condition contributed to the cause of death
// onset[x]: When condition first manifested. One of these 4:
"onsetAge" : { Age },
"onsetRange" : { Range },
"onsetPeriod" : { Period },
"onsetString" : "<string>",
"note" : [{ Annotation }] // Extra information about condition
}],
"procedure" : [{ // Procedures that the related person had
"code" : { CodeableConcept }, // R! Procedures performed on the related person
"outcome" : { CodeableConcept }, // What happened following the procedure
"contributedToDeath" : <boolean>, // Whether the procedure contributed to the cause of death
// performed[x]: When the procedure was performed. One of these 5:
"performedAge" : { Age },
"performedRange" : { Range },
"performedPeriod" : { Period },
"performedString" : "<string>",
"performedDateTime" : "<dateTime>",
"note" : [{ Annotation }] // Extra information about the procedure
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:FamilyMemberHistory; fhir:nodeRole fhir:treeRoot; # if this is the parser root
# from # from fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: # . One of these 3 fhir: ] fhir: ] fhir: ] # . One of these 3 fhir: ] fhir: ] fhir: ] fhir: # . One of these 5 fhir: ] fhir: ] fhir: ] fhir: ] fhir: ] fhir: fhir:| fhir: fhir: fhir: fhir: fhir: # . One of these 4 fhir: ] fhir: ] fhir: ] fhir: ] fhir: ], ...;# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:identifier ( [ Identifier ] ... ) ; # 0..* External Id(s) for this record fhir:status [ code ] ; # 1..1 partial | completed | entered-in-error | health-unknown fhir:dataAbsentReason [ CodeableConcept ] ; # 0..1 subject-unknown | withheld | unable-to-obtain | deferred fhir:patient [ Reference(Patient) ] ; # 1..1 Patient history is about fhir:date [ dateTime ] ; # 0..1 When history was recorded or last updated fhir:recorder [ Reference(CareTeam|Group|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 0..1 Who recorded the family member history fhir:asserter [ Reference(CareTeam|Device|Group|Organization|Patient|Practitioner|PractitionerRole| RelatedPerson) ] ; # 0..1 Person or device that asserts this family member history fhir:name [ string ] ; # 0..1 The family member described fhir:relationship [ CodeableConcept ] ; # 1..1 Relationship to the subject fhir:sex [ CodeableConcept ] ; # 0..1 male | female | other | unknown # born[x] : 0..1 I (approximate) date of birth. One of these 3 fhir:born [ a fhir:Period ; Period ] fhir:born [ a fhir:Date ; date ] fhir:born [ a fhir:String ; string ] # age[x] : 0..1 I (approximate) age. One of these 3 fhir:age [ a fhir:Age ; Age ] fhir:age [ a fhir:Range ; Range ] fhir:age [ a fhir:String ; string ] fhir:estimatedAge [ boolean ] ; # 0..1 I Age is estimated? # deceased[x] : 0..1 I Dead? How old/when?. One of these 5 fhir:deceased [ a fhir:Boolean ; boolean ] fhir:deceased [ a fhir:Age ; Age ] fhir:deceased [ a fhir:Range ; Range ] fhir:deceased [ a fhir:Date ; date ] fhir:deceased [ a fhir:String ; string ] fhir:reason ( [ CodeableReference(AllergyIntolerance|Condition|DiagnosticReport|DocumentReference|Observation| QuestionnaireResponse) ] ... ) ; # 0..* Why was family member history performed? fhir:note ( [ Annotation ] ... ) ; # 0..* General note about related person fhir:condition ( [ # 0..* Condition that the related person had fhir:code [ CodeableConcept ] ; # 1..1 Condition, allergy, or intolerance suffered by relation fhir:outcome [ CodeableConcept ] ; # 0..1 deceased | permanent disability | etc fhir:contributedToDeath [ boolean ] ; # 0..1 Whether the condition contributed to the cause of death # onset[x] : 0..1 When condition first manifested. One of these 4 fhir:onset [ a fhir:Age ; Age ] fhir:onset [ a fhir:Range ; Range ] fhir:onset [ a fhir:Period ; Period ] fhir:onset [ a fhir:String ; string ] fhir:note ( [ Annotation ] ... ) ; # 0..* Extra information about condition ] ... ) ; fhir:procedure ( [ # 0..* Procedures that the related person had fhir:code [ CodeableConcept ] ; # 1..1 Procedures performed on the related person fhir:outcome [ CodeableConcept ] ; # 0..1 What happened following the procedure fhir:contributedToDeath [ boolean ] ; # 0..1 Whether the procedure contributed to the cause of death # performed[x] : 0..1 When the procedure was performed. One of these 5 fhir:performed [ a fhir:Age ; Age ] fhir:performed [ a fhir:Range ; Range ] fhir:performed [ a fhir:Period ; Period ] fhir:performed [ a fhir:String ; string ] fhir:performed [ a fhir:DateTime ; dateTime ] fhir:note ( [ Annotation ] ... ) ; # 0..* Extra information about the procedure ] ... ) ; ]
Changes
since
R3
from
both
R4
and
R4B
| FamilyMemberHistory | |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| FamilyMemberHistory.procedure.performed[x] |
|
| FamilyMemberHistory.procedure.note |
|
|
|
|
|
|
|
|
|
|
|
|
|
See the Full Difference for further information
This
analysis
is
available
for
R4
as
XML
or
JSON
.
See
R3
<-->
R4
Conversion
Maps
(status
=
2
tests
that
all
execute
ok.
All
tests
pass
round-trip
testing
and
1
r3
resources
are
invalid
(0
errors).
)
for
R4B
as
XML
or
JSON
.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
|
|
DomainResource |
Information
about
patient's
relatives,
relevant
for
patient
+ Rule: Can have age[x] or born[x], but not both + Rule: Can only have estimatedAge if age[x] is present + Rule: Can have age[x] or deceased[x], but not both Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
External
Id(s)
for
this
record
|
|
?! Σ | 1..1 |
|
partial
|
Binding: Family History Status |
|
Σ | 0..1 |
|
subject-unknown
|
withheld
|
unable-to-obtain
|
deferred
Binding: Family History Absent Reason ( Example ) |
|
|
1..1 |
|
Patient
history
is
about
|
|
Σ | 0..1 |
|
When
history
was
recorded
or
last
updated
|
|
Σ | 0..1 | Reference ( Practitioner | PractitionerRole | Patient | RelatedPerson | Organization | CareTeam | Group ) |
Who
recorded
the
family
member
history
|
|
Σ | 0..1 |
|
Person
or
|
|
Σ | 0..1 | string |
The
family
member
described
|
|
Σ | 1..1 | CodeableConcept |
Relationship
to
the
subject
Binding: FamilyMember
|
|
Σ | 0..1 | CodeableConcept |
male
|
female
|
other
|
unknown
Binding: AdministrativeGender ( Extensible ) |
|
|
0..1 |
(approximate)
date
of
birth
|
|
|
Period | |||
|
date | |||
|
string | |||
|
Σ
|
0..1 |
(approximate)
age
|
|
|
Age | |||
|
Range | |||
|
string | |||
|
Σ
|
0..1 | boolean |
Age
is
estimated?
|
|
Σ C | 0..1 |
Dead?
How
old/when?
|
|
|
boolean | |||
|
Age | |||
|
Range | |||
|
date | |||
|
string | |||
|
Σ | 0..* |
|
Why
was
family
member
history
performed?
Binding: SNOMED CT Clinical Findings ( Example ) |
|
0..* | Annotation |
General
note
about
related
person
|
|
|
Σ | 0..* | BackboneElement |
Condition
that
the
related
person
had
|
|
Σ | 1..1 | CodeableConcept |
Condition,
allergy,
or
intolerance
suffered
by
relation
Binding: Condition/Problem/Diagnosis Codes ( Example ) |
|
0..1 | CodeableConcept |
deceased
|
permanent
disability
|
Binding: Condition Outcome Codes ( Example ) |
|
|
0..1 | boolean |
Whether
the
condition
contributed
to
the
cause
of
death
|
|
|
0..1 |
When
condition
first
manifested
|
||
|
Age | |||
|
Range | |||
| Period | |||
| string | |||
| 0..* | Annotation |
Extra
information
about
condition
| |
![]() ![]() | 0..* | BackboneElement |
Procedures
that
the
related
person
had
| |
![]() ![]() ![]() | 1..1 | CodeableConcept |
Procedures
performed
on
the
related
person
Binding: Procedure Codes (SNOMED CT) ( Example ) | |
![]() ![]() ![]() | 0..1 | CodeableConcept |
What
happened
following
the
procedure
Binding: SNOMED CT Clinical Findings ( Example ) | |
![]() ![]() ![]() | 0..1 | boolean |
Whether
the
procedure
contributed
to
the
cause
of
death
| |
![]() ![]() ![]() | 0..1 |
When
the
procedure
was
performed
| ||
![]() ![]() ![]() ![]() | Age | |||
|
Range | |||
| Period | |||
|
string | |||
| dateTime | |||
|
0..* | Annotation |
Extra
information
about
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
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>
<| </instantiatesCanonical> <<status value="[code]"/><!-- 1..1 partial | completed | entered-in-error | health-unknown --> <dataAbsentReason><!-- 0..1 CodeableConcept subject-unknown | withheld | unable-to-obtain | deferred --></dataAbsentReason> <patient><!-- 1..1 Reference(Patient) Patient history is about --></patient> <date value="[dateTime]"/><!-- 0..1 When history was recorded or last updated --> <recorder><!-- 0..1 Reference(CareTeam|Group|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) Who recorded the family member history --></recorder> <asserter><!-- 0..1 Reference(CareTeam|Device|Group|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson) Person or device that asserts this family member history --></asserter> <name value="[string]"/><!-- 0..1 The family member described --><</relationship><relationship><!-- 1..1 CodeableConcept Relationship to the subject--></relationship> <sex><!-- 0..1 CodeableConcept male | female | other | unknown --></sex>
<</born[x]> <</age[x]> < <</deceased[x]> <</reasonCode> <| </reasonReference><born[x]><!-- I 0..1 Period|date|string (approximate) date of birth --></born[x]> <age[x]><!-- I 0..1 Age|Range|string (approximate) age --></age[x]> <estimatedAge value="[boolean]"/><!-- I 0..1 Age is estimated? --> <deceased[x]><!-- I 0..1 boolean|Age|Range|date|string Dead? How old/when? --></deceased[x]> <reason><!-- 0..* CodeableReference(AllergyIntolerance|Condition| DiagnosticReport|DocumentReference|Observation|QuestionnaireResponse) Why was family member history performed? --></reason> <note><!-- 0..* Annotation General note about related person --></note> <condition> <!-- 0..* Condition that the related person had --><</code> <</outcome><code><!-- 1..1 CodeableConcept Condition, allergy, or intolerance suffered by relation --></code> <outcome><!-- 0..1 CodeableConcept deceased | permanent disability | etc --></outcome> <contributedToDeath value="[boolean]"/><!-- 0..1 Whether the condition contributed to the cause of death --> <onset[x]><!-- 0..1 Age|Range|Period|string When condition first manifested --></onset[x]> <note><!-- 0..* Annotation Extra information about condition --></note> </condition> <procedure> <!-- 0..* Procedures that the related person had --> <code><!-- 1..1 CodeableConcept Procedures performed on the related person --></code> <outcome><!-- 0..1 CodeableConcept What happened following the procedure --></outcome> <contributedToDeath value="[boolean]"/><!-- 0..1 Whether the procedure contributed to the cause of death --> <performed[x]><!-- 0..1 Age|Range|Period|string|dateTime When the procedure was performed --></performed[x]> <note><!-- 0..* Annotation Extra information about the procedure --></note> </procedure> </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
"|
"
"status" : "<code>", // R! partial | completed | entered-in-error | health-unknown
"dataAbsentReason" : { CodeableConcept }, // subject-unknown | withheld | unable-to-obtain | deferred
"patient" : { Reference(Patient) }, // R! Patient history is about
"date" : "<dateTime>", // When history was recorded or last updated
"recorder" : { Reference(CareTeam|Group|Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson) }, // Who recorded the family member history
"asserter" : { Reference(CareTeam|Device|Group|Organization|Patient|
Practitioner|PractitionerRole|RelatedPerson) }, // Person or device that asserts this family member history
"name" : "<string>", // The family member described
"
"relationship" : { CodeableConcept }, // R! Relationship to the subject
"sex" : { CodeableConcept }, // 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>, // I Age is estimated?
// deceased[x]: Dead? How old/when?. One of these 5:
"deceasedBoolean" : <boolean>,
"deceasedAge" : { Age },
"deceasedRange" : { Range },
"deceasedDate" : "<date>",
"deceasedString" : "<string>",
"
"|
"reason" : [{ CodeableReference(AllergyIntolerance|Condition|
DiagnosticReport|DocumentReference|Observation|QuestionnaireResponse) }], // Why was family member history performed?
"note" : [{ Annotation }], // General note about related person
"condition" : [{ // Condition that the related person had
"
"
"code" : { CodeableConcept }, // R! Condition, allergy, or intolerance suffered by relation
"outcome" : { CodeableConcept }, // deceased | permanent disability | etc
"contributedToDeath" : <boolean>, // Whether the condition contributed to the cause of death
// onset[x]: When condition first manifested. One of these 4:
"onsetAge" : { Age },
"onsetRange" : { Range },
"onsetPeriod" : { Period },
"onsetString" : "<string>",
"note" : [{ Annotation }] // Extra information about condition
}],
"procedure" : [{ // Procedures that the related person had
"code" : { CodeableConcept }, // R! Procedures performed on the related person
"outcome" : { CodeableConcept }, // What happened following the procedure
"contributedToDeath" : <boolean>, // Whether the procedure contributed to the cause of death
// performed[x]: When the procedure was performed. One of these 5:
"performedAge" : { Age },
"performedRange" : { Range },
"performedPeriod" : { Period },
"performedString" : "<string>",
"performedDateTime" : "<dateTime>",
"note" : [{ Annotation }] // Extra information about the procedure
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:FamilyMemberHistory; fhir:nodeRole fhir:treeRoot; # if this is the parser root
# from # from fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: # . One of these 3 fhir: ] fhir: ] fhir: ] # . One of these 3 fhir: ] fhir: ] fhir: ] fhir: # . One of these 5 fhir: ] fhir: ] fhir: ] fhir: ] fhir: ] fhir: fhir:| fhir: fhir: fhir: fhir: fhir: # . One of these 4 fhir: ] fhir: ] fhir: ] fhir: ] fhir: ], ...;# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:identifier ( [ Identifier ] ... ) ; # 0..* External Id(s) for this record fhir:status [ code ] ; # 1..1 partial | completed | entered-in-error | health-unknown fhir:dataAbsentReason [ CodeableConcept ] ; # 0..1 subject-unknown | withheld | unable-to-obtain | deferred fhir:patient [ Reference(Patient) ] ; # 1..1 Patient history is about fhir:date [ dateTime ] ; # 0..1 When history was recorded or last updated fhir:recorder [ Reference(CareTeam|Group|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 0..1 Who recorded the family member history fhir:asserter [ Reference(CareTeam|Device|Group|Organization|Patient|Practitioner|PractitionerRole| RelatedPerson) ] ; # 0..1 Person or device that asserts this family member history fhir:name [ string ] ; # 0..1 The family member described fhir:relationship [ CodeableConcept ] ; # 1..1 Relationship to the subject fhir:sex [ CodeableConcept ] ; # 0..1 male | female | other | unknown # born[x] : 0..1 I (approximate) date of birth. One of these 3 fhir:born [ a fhir:Period ; Period ] fhir:born [ a fhir:Date ; date ] fhir:born [ a fhir:String ; string ] # age[x] : 0..1 I (approximate) age. One of these 3 fhir:age [ a fhir:Age ; Age ] fhir:age [ a fhir:Range ; Range ] fhir:age [ a fhir:String ; string ] fhir:estimatedAge [ boolean ] ; # 0..1 I Age is estimated? # deceased[x] : 0..1 I Dead? How old/when?. One of these 5 fhir:deceased [ a fhir:Boolean ; boolean ] fhir:deceased [ a fhir:Age ; Age ] fhir:deceased [ a fhir:Range ; Range ] fhir:deceased [ a fhir:Date ; date ] fhir:deceased [ a fhir:String ; string ] fhir:reason ( [ CodeableReference(AllergyIntolerance|Condition|DiagnosticReport|DocumentReference|Observation| QuestionnaireResponse) ] ... ) ; # 0..* Why was family member history performed? fhir:note ( [ Annotation ] ... ) ; # 0..* General note about related person fhir:condition ( [ # 0..* Condition that the related person had fhir:code [ CodeableConcept ] ; # 1..1 Condition, allergy, or intolerance suffered by relation fhir:outcome [ CodeableConcept ] ; # 0..1 deceased | permanent disability | etc fhir:contributedToDeath [ boolean ] ; # 0..1 Whether the condition contributed to the cause of death # onset[x] : 0..1 When condition first manifested. One of these 4 fhir:onset [ a fhir:Age ; Age ] fhir:onset [ a fhir:Range ; Range ] fhir:onset [ a fhir:Period ; Period ] fhir:onset [ a fhir:String ; string ] fhir:note ( [ Annotation ] ... ) ; # 0..* Extra information about condition ] ... ) ; fhir:procedure ( [ # 0..* Procedures that the related person had fhir:code [ CodeableConcept ] ; # 1..1 Procedures performed on the related person fhir:outcome [ CodeableConcept ] ; # 0..1 What happened following the procedure fhir:contributedToDeath [ boolean ] ; # 0..1 Whether the procedure contributed to the cause of death # performed[x] : 0..1 When the procedure was performed. One of these 5 fhir:performed [ a fhir:Age ; Age ] fhir:performed [ a fhir:Range ; Range ] fhir:performed [ a fhir:Period ; Period ] fhir:performed [ a fhir:String ; string ] fhir:performed [ a fhir:DateTime ; dateTime ] fhir:note ( [ Annotation ] ... ) ; # 0..* Extra information about the procedure ] ... ) ; ]
Changes
since
Release
3
from
both
R4
and
R4B
| FamilyMemberHistory | |
|
|
|
|
|
|
|
|
|
|
|
|
| FamilyMemberHistory.procedure |
|
|
|
|
|
|
|
|
|
|
|
|
|
| FamilyMemberHistory.procedure.note |
|
|
|
|
|
|
|
|
|
|
|
|
|
See the Full Difference for further information
This
analysis
is
available
for
R4
as
XML
or
JSON
.
See
R3
<-->
R4
Conversion
Maps
(status
=
2
tests
that
all
execute
ok.
All
tests
pass
round-trip
testing
and
1
r3
resources
are
invalid
(0
errors).
)
for
R4B
as
XML
or
JSON
.
See
the
Profiles
&
Extensions
and
the
alternate
Additional
definitions:
Master
Definition
XML
+
JSON
,
XML
Schema
/
Schematron
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
the
extensions
,
the
spreadsheet
version
&
the
dependency
analysis
| Path |
|
Type |
|
|---|---|---|---|
| FamilyMemberHistory.status | FamilyHistoryStatus | Required |
A code that identifies the status of the family history record. |
| FamilyMemberHistory.dataAbsentReason |
|
|
Codes describing the reason why a family member's history is not available. |
| FamilyMemberHistory.relationship |
FamilyMember
|
Example |
A relationship between two people characterizing their "familial" relationship |
| FamilyMemberHistory.sex | AdministrativeGender | Extensible |
The
|
| FamilyMemberHistory.reason | SNOMEDCTClinicalFindings | Example |
This
value
set
includes
all
the
"Clinical
finding"
SNOMED
CT
|
| FamilyMemberHistory.condition.code |
|
|
Example value set for Condition/Problem/Diagnosis codes. |
| FamilyMemberHistory.condition.outcome |
|
Example |
Example value set for condition outcomes. |
| FamilyMemberHistory.procedure.code |
|
Example |
Procedure Code: All SNOMED CT procedure codes. |
| FamilyMemberHistory.procedure.outcome |
|
Example |
This
value
set
includes
all
the
"Clinical
finding"
SNOMED
CT
|
|
|
Level | Location | Description | Expression |
fhs-1
|
Rule | (base) | Can have age[x] or born[x], but not both | age.empty() or born.empty() |
fhs-2
|
Rule | (base) | Can only have estimatedAge if age[x] is present | age.exists() or estimatedAge.empty() |
fhs-3
| Rule | (base) | Can have age[x] or deceased[x], but not both | age.empty() or deceased.empty() |
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.
Not Reviewed, Not Asked
When a sending system does not have family history about any family members or the statement is about family history not yet being asked, then the List resource should be used to indicate the List.emptyReason="notasked".
Reviewed, None Identified for Family
After reasonable investigation that there are no known items for the family member history list, then the List resource should be used to indicate the List.emptyReason="nilknown". The List.emptyReason represents a statement about the full scope of the list (i.e. the patient or patient's agent/guardian has asserted that there are no conditions or significant events for any family members to record).
Reviewed,
None
Identified
No
Information
Available
for
a
Family
Member
When an individual family member's history is not available, FamilyMemberHistory.dataAbsentReason can be used to indicate why that family member's history is not available (e.g. subject unknown).
Reviewed, No Known Problems or Negated Condition for a Family Member
The FamilyMemberHistory.condition.code can be used to capture "No Known Problems" or negated conditions, such as "No history of malignant tumor of breast", for an individual family member.
Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Expression | In Common |
| code | token | A search by a condition code | FamilyMemberHistory.condition.code |
|
| date | date | When history was recorded or last updated | FamilyMemberHistory.date |
|
| identifier | token | A search by a record identifier | FamilyMemberHistory.identifier |
|
|
|
reference | The identity of a subject to list family member history items for |
FamilyMemberHistory.patient
( Patient ) |
|
| relationship | token | A search by a relationship type | FamilyMemberHistory.relationship | |
| sex | token | A search by a sex code of a family member | FamilyMemberHistory.sex | |
| status | token | partial | completed | entered-in-error | health-unknown | FamilyMemberHistory.status |