FHIR Release 3 (STU) R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.0.2: STU 3). (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 Group Maturity Level : 2   Trial Use Compartments : Patient

Detailed Descriptions for the elements in the FamilyMemberHistory resource.

Comments This notDoneReason element is being evaluated and will likely be replaced in a subsequent release (e.g. dataAbsentReason). Invariants
FamilyMemberHistory
Element Id FamilyMemberHistory
Definition

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

Control 1..1
Invariants Defined 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))) fhs-3 : Not Done Reason can only be specified if NotDone is "true" ( expression : notDone or notDoneReason.exists().not(), xpath: f:notDone/@value=true() or not(exists(f:notDoneReason)))
FamilyMemberHistory.identifier
Element Id FamilyMemberHistory.identifier
Definition

This records Business identifiers associated with assigned to this family member history record that are defined by business processes and/ the performer or used to refer to it when a direct URL reference to other systems which remain constant as the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). updated and propagates from server to server.

Note This is a business identifer, not a resource identifier (see discussion )
Control 0..*
Type Identifier
Requirements

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

Summary true
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.definition FamilyMemberHistory.instantiates
Element Id FamilyMemberHistory.instantiates
Definition

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

Control 0..*
Type Reference ( PlanDefinition | Questionnaire uri )
Summary true
FamilyMemberHistory.status
Element Id FamilyMemberHistory.status
Definition

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

Control 1..1
Terminology Binding FamilyHistoryStatus ( Required )
Type code
Is Modifier true (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)
Summary true
Comments

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

FamilyMemberHistory.notDone FamilyMemberHistory.dataAbsentReason
Definition If true, indicates the taking of an individual family member's history did not occur. The notDone element should not be used to document negated conditions, such as a family member that did not have a condition. Control 0..1 Type boolean Is Modifier true Default Value false Requirements Creating a FamilyMemberHistory where notDone is true is intended for situations where there's a need for a specific statement in the record about something not being done. If the need is merely to indicate that a request wasn't fulfilled, that should be handled using Task. Summary true Comments Element Id This element is labeled as a modifier because it marks the family member history as a family member history that did not occur. The more attributes are populated, the more constrained the negated statement is. This notDone element is being evaluated and will likely be removed in a subsequent release. FamilyMemberHistory.notDoneReason FamilyMemberHistory.dataAbsentReason
Definition

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

Control 0..1
Terminology Binding FamilyHistoryNotDoneReason FamilyHistoryAbsentReason ( Example )
Type CodeableConcept
Requirements

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

Summary true
Affect this element FamilyMemberHistory.patient fhs-3 : Not Done Reason can only be specified if NotDone is "true" ( expression : notDone or notDoneReason.exists().not(), xpath: f:notDone/@value=true() or not(exists(f:notDoneReason)))
Element Id FamilyMemberHistory.patient
Definition

The person who this history concerns.

Control 1..1
Type Reference ( Patient )
Alternate Names Proband
Summary true
FamilyMemberHistory.date
Element Id FamilyMemberHistory.date
Definition

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

Control 0..1
Type dateTime
Requirements

Allows determination of how current the summary is.

Summary true
Comments

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

FamilyMemberHistory.name
Element Id FamilyMemberHistory.name
Definition

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

Control 0..1
Type string
Requirements

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

Summary true
FamilyMemberHistory.relationship
Element Id FamilyMemberHistory.relationship
Definition

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

Control 1..1
Terminology Binding FamilyMember ( Example )
Type CodeableConcept
Summary true
FamilyMemberHistory.gender
Element Id FamilyMemberHistory.gender
Definition

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

Control 0..1
Terminology Binding AdministrativeGender ( Required )
Type code
Requirements

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

Summary true
FamilyMemberHistory.born[x]
Element Id FamilyMemberHistory.born[x]
Definition

The actual or approximate date of birth of the relative.

Control 0..1
Type Period | date | string
[x] Note See Choice of Data Types for further information about how to use [x]
Requirements

Allows calculation of the relative's age.

Invariants Affect 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 Id FamilyMemberHistory.age[x]
Definition

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

Control 0..1
Type Age | Range | string
[x] Note See 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 natureal natural for clinicians.

Summary true
Comments

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

Invariants Affect 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 Id FamilyMemberHistory.estimatedAge
Definition

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

Control 0..1
Type boolean
Is Modifier true Meaning if Missing It is unknown whether the age is an estimate or not
Requirements

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

Summary true
Comments

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

Invariants Affect 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 Id FamilyMemberHistory.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.

Control 0..1
Type boolean | Age | Range | date | string
[x] Note See Choice of Data Types for further information about how to use [x]
Summary true
FamilyMemberHistory.reasonCode
Element Id FamilyMemberHistory.reasonCode
Definition

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

Control 0..*
Terminology Binding SNOMED CT Clinical Findings ( Example )
Type CodeableConcept
Summary true
Comments

Textual reasons can be caprued captured using reasonCode.text.

FamilyMemberHistory.reasonReference
Element Id FamilyMemberHistory.reasonReference
Definition

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

Control 0..*
Type Reference ( Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference )
Summary true
FamilyMemberHistory.note
Element Id FamilyMemberHistory.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.

Control 0..*
Type Annotation
FamilyMemberHistory.condition
Element Id FamilyMemberHistory.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.

Control 0..*
Comments

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

FamilyMemberHistory.condition.code
Element Id FamilyMemberHistory.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.

Control 1..1
Terminology Binding Condition/Problem/Diagnosis Codes ( Example )
Type CodeableConcept
FamilyMemberHistory.condition.outcome
Element Id FamilyMemberHistory.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.

Control 0..1
Terminology Binding Condition Outcome Codes ( Example )
Type CodeableConcept
FamilyMemberHistory.condition.onset[x]
Element Id FamilyMemberHistory.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.

Control 0..1
Type Age | Range | Period | string
[x] Note See 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 Id FamilyMemberHistory.condition.note
Definition

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

Control 0..*
Type Annotation