R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: R4 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

Patient Care Work GroupMaturity Level: 2 Trial Use Compartments: Patient

Detailed Descriptions for the elements in the FamilyMemberHistory resource.

FamilyMemberHistory
Element IdFamilyMemberHistory
Definition

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

Control1..1
InvariantsDefined on this element
fhs-1: Can have age[x] or born[x], but not both (expression : age.empty() or born.empty(), xpath: not (*[starts-with(local-name(.), 'age')] and *[starts-with(local-name(.), 'birth')]))
fhs-2: Can only have estimatedAge if age[x] is present (expression : age.exists() or estimatedAge.empty(), xpath: exists(*[starts-with(local-name(.), 'age')]) or not(exists(f:estimatedAge)))
FamilyMemberHistory.identifier
Element IdFamilyMemberHistory.identifier
Definition

Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Allows identification of the family member history as it is known by various participating systems and in a way that remains consistent across servers.

Summarytrue
Comments

This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

FamilyMemberHistory.instantiates
Element IdFamilyMemberHistory.instantiates
Definition

A protocol or questionnaire that was adhered to in whole or in part by this event.

Control0..*
Typeuri
Summarytrue
FamilyMemberHistory.status
Element IdFamilyMemberHistory.status
Definition

A code specifying the status of the record of the family history of a specific family member.

Control1..1
Terminology BindingFamilyHistoryStatus (Required)
Typecode
Is Modifiertrue (Reason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid)
Summarytrue
Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

FamilyMemberHistory.dataAbsentReason
Element IdFamilyMemberHistory.dataAbsentReason
Definition

Describes why the family member's history is not available.

Control0..1
Terminology BindingFamilyHistoryAbsentReason (Example)
TypeCodeableConcept
Requirements

This is a separate element to allow it to have a distinct binding from reasonCode.

Summarytrue
FamilyMemberHistory.patient
Element IdFamilyMemberHistory.patient
Definition

The person who this history concerns.

Control1..1
TypeReference(Patient)
Alternate NamesProband
Summarytrue
FamilyMemberHistory.date
Element IdFamilyMemberHistory.date
Definition

The date (and possibly time) when the family member history was recorded or last updated.

Control0..1
TypedateTime
Requirements

Allows determination of how current the summary is.

Summarytrue
Comments

This should be captured even if the same as the date on the List aggregating the full family history.

FamilyMemberHistory.name
Element IdFamilyMemberHistory.name
Definition

This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".

Control0..1
Typestring
Requirements

Allows greater ease in ensuring the same person is being talked about.

Summarytrue
FamilyMemberHistory.relationship
Element IdFamilyMemberHistory.relationship
Definition

The type of relationship this person has to the patient (father, mother, brother etc.).

Control1..1
Terminology BindingFamilyMember (Example)
TypeCodeableConcept
Summarytrue
FamilyMemberHistory.gender
Element IdFamilyMemberHistory.gender
Definition

Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.

Control0..1
Terminology BindingAdministrativeGender (Required)
Typecode
Requirements

Not all relationship codes imply gender and the relative's gender can be relevant for risk assessments.

Summarytrue
FamilyMemberHistory.born[x]
Element IdFamilyMemberHistory.born[x]
Definition

The actual or approximate date of birth of the relative.

Control0..1
TypePeriod|date|string
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

Allows calculation of the relative's age.

InvariantsAffect this element
fhs-1: Can have age[x] or born[x], but not both (expression : age.empty() or born.empty(), xpath: not (*[starts-with(local-name(.), 'age')] and *[starts-with(local-name(.), 'birth')]))
FamilyMemberHistory.age[x]
Element IdFamilyMemberHistory.age[x]
Definition

The age of the relative at the time the family member history is recorded.

Control0..1
TypeAge|Range|string
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

While age can be calculated from date of birth, sometimes recording age directly is more natural for clinicians.

Summarytrue
Comments

use estimatedAge to indicate whether the age is actual or not.

InvariantsAffect this element
fhs-1: Can have age[x] or born[x], but not both (expression : age.empty() or born.empty(), xpath: not (*[starts-with(local-name(.), 'age')] and *[starts-with(local-name(.), 'birth')]))
FamilyMemberHistory.estimatedAge
Element IdFamilyMemberHistory.estimatedAge
Definition

If true, indicates that the age value specified is an estimated value.

Control0..1
Typeboolean
Meaning if MissingIt is unknown whether the age is an estimate or not
Requirements

Clinicians often prefer to specify an estimaged age rather than an age range.

Summarytrue
Comments

This element is labeled as a modifier because the fact that age is estimated can/should change the results of any algorithm that calculates based on the specified age.

InvariantsAffect this element
fhs-2: Can only have estimatedAge if age[x] is present (expression : age.exists() or estimatedAge.empty(), xpath: exists(*[starts-with(local-name(.), 'age')]) or not(exists(f:estimatedAge)))
FamilyMemberHistory.deceased[x]
Element IdFamilyMemberHistory.deceased[x]
Definition

Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

Control0..1
Typeboolean|Age|Range|date|string
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
FamilyMemberHistory.reasonCode
Element IdFamilyMemberHistory.reasonCode
Definition

Describes why the family member history occurred in coded or textual form.

Control0..*
Terminology BindingSNOMED CT Clinical Findings (Example)
TypeCodeableConcept
Summarytrue
Comments

Textual reasons can be captured using reasonCode.text.

FamilyMemberHistory.reasonReference
Element IdFamilyMemberHistory.reasonReference
Definition

Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.

Control0..*
TypeReference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference)
Summarytrue
FamilyMemberHistory.note
Element IdFamilyMemberHistory.note
Definition

This 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 possible.

Control0..*
TypeAnnotation
FamilyMemberHistory.condition
Element IdFamilyMemberHistory.condition
Definition

The 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 condition.

Control0..*
Comments

If none of the conditions listed have an outcome of "death" specified, that indicates that none of the specified conditions are known to have been the primary cause of death.

FamilyMemberHistory.condition.code
Element IdFamilyMemberHistory.condition.code
Definition

The 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 system.

Control1..1
Terminology BindingCondition/Problem/Diagnosis Codes (Example)
TypeCodeableConcept
FamilyMemberHistory.condition.outcome
Element IdFamilyMemberHistory.condition.outcome
Definition

Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation.

Control0..1
Terminology BindingCondition Outcome Codes (Example)
TypeCodeableConcept
FamilyMemberHistory.condition.onset[x]
Element IdFamilyMemberHistory.condition.onset[x]
Definition

Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.

Control0..1
TypeAge|Range|Period|string
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

Age of onset of a condition in relatives is predictive of risk for the patient.

FamilyMemberHistory.condition.note
Element IdFamilyMemberHistory.condition.note
Definition

An area where general notes can be placed about this specific condition.

Control0..*
TypeAnnotation