DSTU2 Ballot Source

This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). 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

4.28 Resource FamilyMemberHistory - Content

This resource maintained by the Patient Care Work Group

Significant health events and conditions for a person related to the patient relevant in the context of care for the patient.

4.28.1 Scope and Usage

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.

This resource is referenced by ClinicalImpression and Procedure

4.28.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory IDomainResourceInformation about patient's relatives, relevant for patient
Can have age[x] or birth[x], but not both
... identifier 0..*IdentifierExternal Id(s) for this record
... patient Σ1..1PatientPatient history is about
... date Σ0..1dateTimeWhen history was captured/updated
... name Σ0..1stringThe family member described
... relationship Σ1..1CodeableConceptRelationship to the subject
FamilialRelationship (Required)
... gender Σ0..1codemale | female | other | unknown
AdministrativeGender (Required)
... born[x] I(approximate) date of birth
.... bornPeriod0..1Period
.... bornDate0..1date
.... bornString0..1string
... age[x] I(approximate) age
.... ageAge0..1Age
.... ageRange0..1Range
.... ageString0..1string
... deceased[x] Dead? How old/when?
.... deceasedBoolean0..1boolean
.... deceasedAge0..1Age
.... deceasedRange0..1Range
.... deceasedDate0..1date
.... deceasedString0..1string
... note 0..1stringGeneral note about related person
... condition 0..*ElementCondition that the related person had
.... type 1..1CodeableConceptCondition suffered by relation
.... outcome 0..1CodeableConceptdeceased | permanent disability | etc.
.... onset[x] When condition first manifested
..... onsetAge0..1Age
..... onsetRange0..1Range
..... onsetString0..1string
.... note 0..1stringExtra information about condition

UML Diagram

FamilyMemberHistory (DomainResource)This records identifiers associated with this family member history record that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)identifier : Identifier 0..*The person who this history concernspatient : Reference(Patient) 1..1The date (and possibly time) when the family member history was takendate : dateTime 0..1This will either be a name or a description. E.g. "Aunt Susan", "my cousin with the red hair"name : string 0..1The type of relationship this person has to the patient (father, mother, brother etc.)relationship : CodeableConcept 1..1 « The nature of the relationship between the patient and the related person being described in the family member historyFamilialRelationship »Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposesgender : code 0..1 « The gender of a person used for administrative purposesAdministrativeGender »The actual or approximate date of birth of the relativeborn[x] : Period|date|string 0..1The actual or approximate age of the relative at the time the family member history is recordedage[x] : Age|Range|string 0..1The actual or approximate age of the relative at the time the family member history is recordeddeceased[x] : boolean|Age|Range|date|string 0..1This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possiblenote : string 0..1ConditionThe actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating systemtype : CodeableConcept 1..1Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relationoutcome : CodeableConcept 0..1Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrenceonset[x] : Age|Range|string 0..1An area where general notes can be placed about this specific conditionnote : string 0..1The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per conditioncondition0..*

XML Template

<FamilyMemberHistory xmlns="http://hl7.org/fhir"> doco
 <!-- 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 -->
 <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]>
 <deceased[x]><!-- 0..1 boolean|Age|Range|date|string Dead? How old/when? --></deceased[x]>
 <note value="[string]"/><!-- 0..1 General note about related person -->
 <condition>  <!-- 0..* Condition that the related person had -->
  <type><!-- 1..1 CodeableConcept Condition suffered by relation --></type>
  <outcome><!-- 0..1 CodeableConcept deceased | permanent disability | etc. --></outcome>
  <onset[x]><!-- 0..1 Age|Range|string When condition first manifested --></onset[x]>
  <note value="[string]"/><!-- 0..1 Extra information about condition -->
 </condition>
</FamilyMemberHistory>

JSON Template

{doco
  "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
  "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>",
  // deceased[x]: Dead? How old/when?. One of these 5:
  "deceasedBoolean" : <boolean>,
  "deceasedAge" : { Age },
  "deceasedRange" : { Range },
  "deceasedDate" : "<date>",
  "deceasedString" : "<string>",
  "note" : "<string>", // General note about related person
  "condition" : [{ // Condition that the related person had
    "type" : { CodeableConcept }, // R!  Condition suffered by relation
    "outcome" : { CodeableConcept }, // deceased | permanent disability | etc.
    // onset[x]: When condition first manifested. One of these 3:
    "onsetAge" : { Age },
    "onsetRange" : { Range },
    "onsetString" : "<string>",
    "note" : "<string>" // Extra information about condition
  }]
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory IDomainResourceInformation about patient's relatives, relevant for patient
Can have age[x] or birth[x], but not both
... identifier 0..*IdentifierExternal Id(s) for this record
... patient Σ1..1PatientPatient history is about
... date Σ0..1dateTimeWhen history was captured/updated
... name Σ0..1stringThe family member described
... relationship Σ1..1CodeableConceptRelationship to the subject
FamilialRelationship (Required)
... gender Σ0..1codemale | female | other | unknown
AdministrativeGender (Required)
... born[x] I(approximate) date of birth
.... bornPeriod0..1Period
.... bornDate0..1date
.... bornString0..1string
... age[x] I(approximate) age
.... ageAge0..1Age
.... ageRange0..1Range
.... ageString0..1string
... deceased[x] Dead? How old/when?
.... deceasedBoolean0..1boolean
.... deceasedAge0..1Age
.... deceasedRange0..1Range
.... deceasedDate0..1date
.... deceasedString0..1string
... note 0..1stringGeneral note about related person
... condition 0..*ElementCondition that the related person had
.... type 1..1CodeableConceptCondition suffered by relation
.... outcome 0..1CodeableConceptdeceased | permanent disability | etc.
.... onset[x] When condition first manifested
..... onsetAge0..1Age
..... onsetRange0..1Range
..... onsetString0..1string
.... note 0..1stringExtra information about condition

UML Diagram

FamilyMemberHistory (DomainResource)This records identifiers associated with this family member history record that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)identifier : Identifier 0..*The person who this history concernspatient : Reference(Patient) 1..1The date (and possibly time) when the family member history was takendate : dateTime 0..1This will either be a name or a description. E.g. "Aunt Susan", "my cousin with the red hair"name : string 0..1The type of relationship this person has to the patient (father, mother, brother etc.)relationship : CodeableConcept 1..1 « The nature of the relationship between the patient and the related person being described in the family member historyFamilialRelationship »Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposesgender : code 0..1 « The gender of a person used for administrative purposesAdministrativeGender »The actual or approximate date of birth of the relativeborn[x] : Period|date|string 0..1The actual or approximate age of the relative at the time the family member history is recordedage[x] : Age|Range|string 0..1The actual or approximate age of the relative at the time the family member history is recordeddeceased[x] : boolean|Age|Range|date|string 0..1This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possiblenote : string 0..1ConditionThe actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating systemtype : CodeableConcept 1..1Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relationoutcome : CodeableConcept 0..1Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrenceonset[x] : Age|Range|string 0..1An area where general notes can be placed about this specific conditionnote : string 0..1The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per conditioncondition0..*

XML Template

<FamilyMemberHistory xmlns="http://hl7.org/fhir"> doco
 <!-- 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 -->
 <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]>
 <deceased[x]><!-- 0..1 boolean|Age|Range|date|string Dead? How old/when? --></deceased[x]>
 <note value="[string]"/><!-- 0..1 General note about related person -->
 <condition>  <!-- 0..* Condition that the related person had -->
  <type><!-- 1..1 CodeableConcept Condition suffered by relation --></type>
  <outcome><!-- 0..1 CodeableConcept deceased | permanent disability | etc. --></outcome>
  <onset[x]><!-- 0..1 Age|Range|string When condition first manifested --></onset[x]>
  <note value="[string]"/><!-- 0..1 Extra information about condition -->
 </condition>
</FamilyMemberHistory>

JSON Template

{doco
  "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
  "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>",
  // deceased[x]: Dead? How old/when?. One of these 5:
  "deceasedBoolean" : <boolean>,
  "deceasedAge" : { Age },
  "deceasedRange" : { Range },
  "deceasedDate" : "<date>",
  "deceasedString" : "<string>",
  "note" : "<string>", // General note about related person
  "condition" : [{ // Condition that the related person had
    "type" : { CodeableConcept }, // R!  Condition suffered by relation
    "outcome" : { CodeableConcept }, // deceased | permanent disability | etc.
    // onset[x]: When condition first manifested. One of these 3:
    "onsetAge" : { Age },
    "onsetRange" : { Range },
    "onsetString" : "<string>",
    "note" : "<string>" // Extra information about condition
  }]
}

 

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON)

4.28.2.1 Terminology Bindings

PathDefinitionTypeReference
FamilyMemberHistory.relationship The nature of the relationship between the patient and the related person being described in the family member historyRequiredhttp://hl7.org/fhir/v3/vs/FamilyMember
FamilyMemberHistory.gender The gender of a person used for administrative purposesRequiredhttp://hl7.org/fhir/administrative-gender
FamilyMemberHistory.condition.outcome The result of the condition for the patient. E.g. death, permanent disability, temporary disability, etc.UnknownNo details provided yet

4.28.2.2 Constraints

  • fhs-1: Can have age[x] or birth[x], but not both (xpath: not (*[starts-with(local-name(.), 'age')] and *[starts-with(local-name(.), 'birth')]))

4.28.3 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPaths
datedateWhen history was captured/updatedFamilyMemberHistory.date
patientreferenceThe identity of a subject to list family member history items forFamilyMemberHistory.patient
(Patient)