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