This page is part of the FHIR Specification (v3.0.2: STU 3). 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
Definitions for the familymemberhistory-genetic Profile.
FamilyMemberHistory | |
Definition | Significant health events and conditions for a person related to the patient relevant in the context of care for the patient. |
Control | 0..* |
Invariants | Defined on this element dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (xpath: not(parent::f:contained and f:text)) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (xpath: not(parent::f:contained and f:contained)) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (xpath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (xpath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))) fhs-1: Can have age[x] or born[x], but not both (xpath: not (*[starts-with(local-name(.), 'age')] and *[starts-with(local-name(.), 'birth')])) fhs-2: Can only have estimatedAge if age[x] is present (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" (xpath: f:notDone/@value=true() or not(exists(f:notDoneReason))) |
FamilyMemberHistory.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
FamilyMemberHistory.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
FamilyMemberHistory.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
FamilyMemberHistory.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Terminology Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable |
Type | code |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
FamilyMemberHistory.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. |
FamilyMemberHistory.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. |
FamilyMemberHistory.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Slicing | This element introduces a set of slices. The slicing rules are:
|
FamilyMemberHistory.extension (http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-parent) | |
Definition | Identifies a parent of the relative. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta) |
Comments | Some individuals may have more than two parents (e.g. genetic vs. adoptive parents). Even non-genetic relationships can be relevant in terms of genetic exposure. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div) ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])) |
FamilyMemberHistory.extension (http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-sibling) | |
Definition | Identifies a sibling of the relative. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta) |
Comments | Some cases may have complex inner-pedigree-tree relationship. For instance, double cousin relationship need two extra link with In pedigree tree itself. This can't be revealed by relationship to subject. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div) ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])) |
FamilyMemberHistory.extension (http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-observation) | |
Definition | Allows capturing risk-relevant observations about the relative that aren't themselves a specific health condition; e.g. Certain ethnic ancestries that are disease-relevant, presence of particular genetic markers, etc. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Reference(Observation)) |
Comments | This may be extended with additional genomics-specific resources when they are ready. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div) ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])) |
FamilyMemberHistory.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
FamilyMemberHistory.identifier | |
Definition | 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). |
Control | 0..* |
Type | Identifier |
Requirements | Need to allow connection to a wider workflow. |
FamilyMemberHistory.definition | |
Definition | A protocol or questionnaire that was adhered to in whole or in part by this event. |
Control | 0..* |
Type | Choice of: Reference(PlanDefinition), Reference(Questionnaire) |
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 | A code that identifies the status of the family history record. The codes SHALL be taken from FamilyHistoryStatus |
Type | code |
Is Modifier | true |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
FamilyMemberHistory.notDone | |
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 |
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. |
Comments | 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. |
Default Value | false |
FamilyMemberHistory.notDoneReason | |
Definition | Describes why the family member's history is absent. |
Control | 0..1 This element is affected by the following invariants: fhs-3 |
Terminology Binding | Codes describing the reason why a family member history was not done. For example codes, see FamilyHistoryNotDoneReason |
Type | CodeableConcept |
Requirements | This is a separate element to allow it to have a distinct binding from reasonCode. |
Comments | This notDoneReason element is being evaluated and will likely be replaced in a subsequent release (e.g. dataAbsentReason). |
FamilyMemberHistory.patient | |
Definition | The person who this history concerns. |
Control | 1..1 |
Type | Reference(Patient) |
Alternate Names | Proband |
FamilyMemberHistory.date | |
Definition | The date (and possibly time) when the family member history was taken. |
Control | 0..1 |
Type | dateTime |
Requirements | Allows determination of how current the summary is. |
Comments | This should be captured even if the same as the date on the List aggregating the full family history. |
FamilyMemberHistory.name | |
Definition | This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair". |
Control | 0..1 |
Type | string |
Requirements | Allows greater ease in ensuring the same person is being talked about. |
FamilyMemberHistory.relationship(Relationship) | |
Definition | The type of relationship this person has to the patient (father, mother, brother etc.). |
Control | 1..1 |
Terminology Binding | The nature of the relationship between the patient and the related person being described in the family member history. For example codes, see FamilyMember |
Type | CodeableConcept |
Must Support | true |
FamilyMemberHistory.gender(Gender) | |
Definition | Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes. |
Control | 0..1 |
Terminology Binding | The gender of a person used for administrative purposes. The codes SHALL be taken from AdministrativeGender |
Type | code |
Must Support | true |
Requirements | Not all relationship codes imply gender and the relative's gender can be relevant for risk assessments. |
FamilyMemberHistory.born[x](BornAge) | |
Definition | The actual or approximate date of birth of the relative. |
Control | 0..1 This element is affected by the following invariants: fhs-1 |
Type | Choice of: Period, date, string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | Allows calculation of the relative's age. |
FamilyMemberHistory.age[x](Age) | |
Definition | The age of the relative at the time the family member history is recorded. |
Control | 0..1 This element is affected by the following invariants: fhs-1 |
Type | Choice of: Age, Range, string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | While age can be calculated from date of birth, sometimes recording age directly is more natureal for clinicians. |
Comments | use estimatedAge to indicate whether the age is actual or not. |
FamilyMemberHistory.estimatedAge | |
Definition | If true, indicates that the age value specified is an estimated value. |
Control | 0..1 This element is affected by the following invariants: fhs-2 |
Type | boolean |
Is Modifier | true |
Requirements | Clinicians often prefer to specify an estimaged age rather than an age range. |
Comments | This element is labeled as a modifier because the fact tha age is estimated can/should change the results of any algorithm that calculates based on the specified age. |
Meaning if Missing | It is unknown whether the age is an estimate or not |
FamilyMemberHistory.deceased[x](DeceasedAge) | |
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 | Choice of: boolean, Age, Range, date, string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
FamilyMemberHistory.reasonCode | |
Definition | Describes why the family member history occurred in coded or textual form. |
Control | 0..* |
Terminology Binding | Codes indicating why the family member history was done. For example codes, see SNOMED CT Clinical Findings |
Type | CodeableConcept |
Comments | Textual reasons can be caprued using reasonCode.text. |
FamilyMemberHistory.reasonReference | |
Definition | Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event. |
Control | 0..* |
Type | Choice of: Reference(Condition), Reference(Observation), Reference(AllergyIntolerance), Reference(QuestionnaireResponse) |
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(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..* |
Type | BackboneElement |
Must Support | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div) |
FamilyMemberHistory.condition.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
FamilyMemberHistory.condition.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
FamilyMemberHistory.condition.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
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 | Identification of the Condition or diagnosis. For example codes, see Condition/Problem/Diagnosis Codes |
Type | CodeableConcept |
Must Support | true |
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 | The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc. For example codes, see Condition Outcome Codes |
Type | CodeableConcept |
Must Support | true |
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 | Choice of: Age, Range, Period, string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | Age of onset of a condition in relatives is predictive of risk for the patient. |
FamilyMemberHistory.condition.note | |
Definition | An area where general notes can be placed about this specific condition. |
Control | 0..1 |
Type | Annotation |