This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Profile for familyhistory
<Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory" title="Significant health events and conditions for people related to the subject relevant in the context of care for the subject."><b>FamilyHistory</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- from <a href="resources.html">Resource</a>: <a href="extensibility.html">extension</a>, <a href="extensibility.html#modifierExtension">modifierExtension</a>, language, <a href="narrative.html#Narrative">text</a>, and <a href="references.html#contained">contained</a> --> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.identifier" title="This records identifiers associated with this family 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)."><b>identifier</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="datatypes.html#Identifier">Identifier</a></span> <span style="color: navy">External Id(s) for this record<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.subject" title="The person who this history concerns."><b>subject</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="patient.html#Patient">Patient</a>)</span> <span style="color: navy">Patient history is about<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></subject> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.note" title="Conveys information about family history not specific to individual relations."><b>note</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Additional details not covered elsewhere</span><span style="color: Gray"> --></span> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation" title="The related person. Each FamilyHistory resource contains the entire family history for a single person."><b>relation</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Relative described by history --></span> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.name" title="This will either be a name or a description. E.g. "Aunt Susan", "my cousin with the red hair"."><b>name</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">The family member described<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.relationship" title="The type of relationship this person has to the patient (father, mother, brother etc.)."><b>relationship</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#CodeableConcept">CodeableConcept</a></span> <a href="v3/vs/FamilyMember/index.html" style="color: navy">Relationship to the subject<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a><span style="color: Gray"> --></span></relationship> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.born_x_" title="The actual or approximate date of birth of the relative."><b>born[x]</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#Period">Period</a>|<a href="datatypes.html#date">date</a>|<a href="datatypes.html#string">string</a></span> <span style="color: navy">(approximate) date of birth</span><span style="color: Gray"> --></span></born[x]> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.deceased_x_" title="If this resource is indicating that the related person is deceased, then an indicator of whether the person is deceased (yes) or not (no) or the age or age range or description of age at death - can be indicated here. If the reason for death is known, then it can be indicated in the outcome code of the condition - in this case the deceased property should still be set."><b>deceased[x]</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#boolean">boolean</a>|<a href="datatypes.html#Age">Age</a>|<a href="datatypes.html#Range">Range</a>|<a href="datatypes.html#date">date</a>|<a href="datatypes.html#string">string</a></span> <span style="color: navy">Dead? How old/when?</span><span style="color: Gray"> --></span></deceased[x]> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.note" title="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."><b>note</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">General note about related person</span><span style="color: Gray"> --></span> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.condition" title="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."><b>condition</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Condition that the related person had --></span> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.condition.type" title="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."><b>type</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#CodeableConcept">CodeableConcept</a></span> <span style="color: navy">Condition suffered by relation</span><span style="color: Gray"> --></span></type> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.condition.outcome" title="Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation."><b>outcome</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#CodeableConcept">CodeableConcept</a></span> <span style="color: navy">deceased | permanent disability | etc.</span><span style="color: Gray"> --></span></outcome> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.condition.onset_x_" title="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."><b>onset[x]</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#Age">Age</a>|<a href="datatypes.html#Range">Range</a>|<a href="datatypes.html#string">string</a></span> <span style="color: navy">When condition first manifested</span><span style="color: Gray"> --></span></onset[x]> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.condition.note" title="An area where general notes can be placed about this specific condition."><b>note</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Extra information about condition</span><span style="color: Gray"> --></span> </condition> </relation> </FamilyHistory> </pre></div> </text> <name value="familyhistory"/> <publisher value="FHIR Project"/> <description value="Basic Profile. Significant health events and conditions for people related to the subject relevant in the context of care for the subject."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="Scope and Usage This resource records significant health events and conditions for people 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. 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 is stored in a single resource."/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="FamilyHistory"/> <publish value="true"/> <element> <path value="FamilyHistory"/> <definition> <short value="Information about patient's relatives, relevant for patient"/> <formal value="Significant health events and conditions for people related to the subject relevant in the context of care for the subject."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Observation[classCode=OBS, moodCode=EVN]"/> </mapping> <mapping> <identity value="v2"/> <map value="Not in scope for v2"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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."/> <comments value="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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="FamilyHistory.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 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."/> <comments value="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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="FamilyHistory.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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."/> <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="FamilyHistory.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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."/> <comments value="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."/> <synonym value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="FamilyHistory.identifier"/> <definition> <short value="External Id(s) for this record"/> <formal value="This records identifiers associated with this family 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)."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="id"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.subject"/> <definition> <short value="Patient history is about"/> <formal value="The person who this history concerns."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=SBJ].role"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.note"/> <definition> <short value="Additional details not covered elsewhere"/> <formal value="Conveys information about family history not specific to individual relations."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.relation"/> <definition> <short value="Relative described by history"/> <formal value="The related person. Each FamilyHistory resource contains the entire family history for a single person."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=SBJ].role[classCode=PAT].player[classCode<LIV, moodCode=INSTANCE].scopedRo le"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.relation.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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."/> <comments value="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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="FamilyHistory.relation.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 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."/> <comments value="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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="FamilyHistory.relation.name"/> <definition> <short value="The family member described"/> <formal value="This will either be a name or a description. E.g. "Aunt Susan", "my cousin with the red hair"."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="name"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.relation.relationship"/> <definition> <short value="Relationship to the subject"/> <formal value="The type of relationship this person has to the patient (father, mother, brother etc.)."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="FamilialRelationship"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/v3/vs/FamilyMember"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="code"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.relation.born[x]"/> <definition> <short value="(approximate) date of birth"/> <formal value="The actual or approximate date of birth of the relative."/> <min value="0"/> <max value="1"/> <type> <code value="Period"/> </type> <type> <code value="date"/> </type> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="player[classCode=LIV, determinerCode=INSTANCE]. birthDate (could be URG)"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.relation.deceased[x]"/> <definition> <short value="Dead? How old/when?"/> <formal value="If this resource is indicating that the related person is deceased, then an indicator of whether the person is deceased (yes) or not (no) or the age or age range or description of age at death - can be indicated here. If the reason for death is known, then it can be indicated in the outcome code of the condition - in this case the deceased property should still be set."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <type> <code value="Age"/> </type> <type> <code value="Range"/> </type> <type> <code value="date"/> </type> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="player[classCode=LIV, determinerCode=INSTANCE].deceasedInd, deceasedDate (could be URG) For age, you'd hang an observation off the role"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.relation.note"/> <definition> <short value="General note about related person"/> <formal value="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."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.relation.condition"/> <definition> <short value="Condition that the related person had"/> <formal value="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."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION, value<Diagnosis]"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.relation.condition.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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."/> <comments value="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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="FamilyHistory.relation.condition.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 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."/> <comments value="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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="FamilyHistory.relation.condition.type"/> <definition> <short value="Condition suffered by relation"/> <formal value="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."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".value"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.relation.condition.outcome"/> <definition> <short value="deceased | permanent disability | etc."/> <formal value="Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ConditionOutcome"/> <isExtensible value="true"/> <conformance value="preferred"/> <description value="The result of the condition for the patient. E.g. death, permanent disability, temporary disability, etc."/> </binding> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=OUTC)].target[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION].val ue"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.relation.condition.onset[x]"/> <definition> <short value="When condition first manifested"/> <formal value="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."/> <min value="0"/> <max value="1"/> <type> <code value="Age"/> </type> <type> <code value="Range"/> </type> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="Subject Age at measurement", value<Diagnosis].value[@xsi:typeCode='TS' or 'IVL_TS'] Use originalText for string"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.relation.condition.note"/> <definition> <short value="Extra information about condition"/> <formal value="An area where general notes can be placed about this specific condition."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="The identity of a subject to list family history items for"/> <xpath value="f:FamilyHistory/f:subject"/> </searchParam> </structure> </Profile>