FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Patient Care icon Work GroupMaturity Level: 2 Trial UseSecurity Category: Patient 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.

Short DisplayInformation about patient's relatives, relevant for patient
Cardinality0..*
TypeDomainResource
Summaryfalse
Invariants
Defined on this element
fhs-1Rule Can have age[x] or born[x], but not bothage.empty() or born.empty()
fhs-2Rule Can only have estimatedAge if age[x] is presentage.exists() or estimatedAge.empty()
fhs-3Rule Can have age[x] or deceased[x], but not bothage.empty() or deceased.empty()
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.

Short DisplayExternal Id(s) for this record
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
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.instantiatesCanonical
Element IdFamilyMemberHistory.instantiatesCanonical
Definition

The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

Short DisplayInstantiates FHIR protocol or definition
Cardinality0..*
Typecanonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)
Summarytrue
FamilyMemberHistory.instantiatesUri
Element IdFamilyMemberHistory.instantiatesUri
Definition

The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

Short DisplayInstantiates external protocol or definition
Cardinality0..*
Typeuri
Summarytrue
Comments

This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

FamilyMemberHistory.status
Element IdFamilyMemberHistory.status
Definition

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

Short Displaypartial | completed | entered-in-error | health-unknown
Cardinality1..1
Terminology BindingFamily History Status (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.

Short Displaysubject-unknown | withheld | unable-to-obtain | deferred
Cardinality0..1
Terminology BindingFamily History Absent Reason (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.

Short DisplayPatient history is about
Cardinality1..1
TypeReference(Patient)
Alternate NamesProband
Summarytrue
Comments

This is not the family member.

FamilyMemberHistory.date
Element IdFamilyMemberHistory.date
Definition

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

Short DisplayWhen history was recorded or last updated
Cardinality0..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.participant
Element IdFamilyMemberHistory.participant
Definition

Indicates who or what participated in the activities related to the family member history and how they were involved.

Short DisplayWho or what participated in the activities related to the family member history and how they were involved
Cardinality0..*
Summarytrue
FamilyMemberHistory.participant.function
Element IdFamilyMemberHistory.participant.function
Definition

Distinguishes the type of involvement of the actor in the activities related to the family member history.

Short DisplayType of involvement
Cardinality0..1
Terminology BindingParticipation Role Type (Extensible)
TypeCodeableConcept
Summarytrue
FamilyMemberHistory.participant.actor
Element IdFamilyMemberHistory.participant.actor
Definition

Indicates who or what participated in the activities related to the family member history.

Short DisplayWho or what participated in the activities related to the family member history
Cardinality1..1
TypeReference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device | Organization | CareTeam)
Summarytrue
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".

Short DisplayThe family member described
Cardinality0..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.).

Short DisplayRelationship to the subject
Cardinality1..1
Terminology BindingFamilyMember icon (Example)
TypeCodeableConcept
Summarytrue
FamilyMemberHistory.sex
Element IdFamilyMemberHistory.sex
Definition

The birth sex of the family member.

Short Displaymale | female | other | unknown
Cardinality0..1
Terminology BindingAdministrativeGender (Extensible)
TypeCodeableConcept
Requirements

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

Summarytrue
Comments

This element should ideally reflect whether the individual is genetically male or female. However, as reported information based on the knowledge of the patient or reporting friend/relative, there may be situations where the reported sex might not be totally accurate. E.g. 'Aunt Sue' might be XY rather than XX. Questions soliciting this information should be phrased to encourage capture of genetic sex where known. However, systems performing analysis should also allow for the possibility of imprecision with this element.

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

The actual or approximate date of birth of the relative.

Short Display(approximate) date of birth
Cardinality0..1
TypePeriod|date|string
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Requirements

Allows calculation of the relative's age.

Summaryfalse
Invariants
Affect this element
fhs-1Rule Can have age[x] or born[x], but not bothage.empty() or born.empty()
FamilyMemberHistory.age[x]
Element IdFamilyMemberHistory.age[x]
Definition

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

Short Display(approximate) age
Cardinality0..1
TypeAge|Range|string
[x] NoteSee Choice of Datatypes 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.

Invariants
Affect this element
fhs-2Rule Can only have estimatedAge if age[x] is presentage.exists() or estimatedAge.empty()
fhs-1Rule Can have age[x] or born[x], but not bothage.empty() or born.empty()
fhs-3Rule Can have age[x] or deceased[x], but not bothage.empty() or deceased.empty()
FamilyMemberHistory.estimatedAge
Element IdFamilyMemberHistory.estimatedAge
Definition

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

Short DisplayAge is estimated?
Cardinality0..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.

Invariants
Affect this element
fhs-2Rule Can only have estimatedAge if age[x] is presentage.exists() or estimatedAge.empty()
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.

Short DisplayDead? How old/when?
Cardinality0..1
Typeboolean|Age|Range|date|string
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
Invariants
Affect this element
fhs-3Rule Can have age[x] or deceased[x], but not bothage.empty() or deceased.empty()
FamilyMemberHistory.reason
Element IdFamilyMemberHistory.reason
Definition

Describes why the family member history occurred in coded or textual form, or Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.

Short DisplayWhy was family member history performed?
Cardinality0..*
Terminology BindingSNOMED CT Clinical Findings (Example)
TypeCodeableReference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference)
Summarytrue
Comments

Textual reasons can be captured using reasonCode.text.

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.

Short DisplayGeneral note about related person
Cardinality0..*
TypeAnnotation
Summaryfalse
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.

Short DisplayCondition that the related person had
Cardinality0..*
Summaryfalse
FamilyMemberHistory.condition.code
Element IdFamilyMemberHistory.condition.code
Definition

The actual condition, allergy, or intolerance 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.

Short DisplayCondition, allergy, or intolerance suffered by relation
Cardinality1..1
Terminology BindingCondition/Problem/Diagnosis Codes (Example)
TypeCodeableConcept
Summaryfalse
FamilyMemberHistory.condition.outcome
Element IdFamilyMemberHistory.condition.outcome
Definition

Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation.

Short Displaydeceased | permanent disability | etc
Cardinality0..1
Terminology BindingCondition Outcome Codes (Example)
TypeCodeableConcept
Summaryfalse
FamilyMemberHistory.condition.contributedToDeath
Element IdFamilyMemberHistory.condition.contributedToDeath
Definition

This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.

Short DisplayWhether the condition contributed to the cause of death
Cardinality0..1
Typeboolean
Summaryfalse
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.

Short DisplayWhen condition first manifested
Cardinality0..1
TypeAge|Range|Period|string
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Requirements

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

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

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

Short DisplayExtra information about condition
Cardinality0..*
TypeAnnotation
Summaryfalse
FamilyMemberHistory.procedure
Element IdFamilyMemberHistory.procedure
Definition

The significant Procedures (or procedure) that the family member had. This is a repeating section to allow a system to represent more than one procedure per resource, though there is nothing stopping multiple resources - one per procedure.

Short DisplayProcedures that the related person had
Cardinality0..*
Summaryfalse
FamilyMemberHistory.procedure.code
Element IdFamilyMemberHistory.procedure.code
Definition

The actual procedure specified. Could be a coded procedure or a less specific string depending on how much is known about the procedure and the capabilities of the creating system.

Short DisplayProcedures performed on the related person
Cardinality1..1
Terminology BindingProcedure Codes (SNOMED CT) (Example)
TypeCodeableConcept
Summaryfalse
FamilyMemberHistory.procedure.outcome
Element IdFamilyMemberHistory.procedure.outcome
Definition

Indicates what happened following the procedure. If the procedure resulted in death, deceased date is captured on the relation.

Short DisplayWhat happened following the procedure
Cardinality0..1
Terminology BindingSNOMED CT Clinical Findings (Example)
TypeCodeableConcept
Summaryfalse
FamilyMemberHistory.procedure.contributedToDeath
Element IdFamilyMemberHistory.procedure.contributedToDeath
Definition

This procedure contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.

Short DisplayWhether the procedure contributed to the cause of death
Cardinality0..1
Typeboolean
Summaryfalse
FamilyMemberHistory.procedure.performed[x]
Element IdFamilyMemberHistory.procedure.performed[x]
Definition

Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

Short DisplayWhen the procedure was performed
Cardinality0..1
TypeAge|Range|Period|string|dateTime
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
FamilyMemberHistory.procedure.note
Element IdFamilyMemberHistory.procedure.note
Definition

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

Short DisplayExtra information about the procedure
Cardinality0..*
TypeAnnotation
Summaryfalse