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
QICore-FamilyHistory
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="familyhistory-qicore-qicore-familyhistory"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div> </text> <url value="http://hl7.org/fhir/StructureDefinition/familyhistory-qicore-qicore-familyhistory"/> <name value="QICore-FamilyHistory"/> <publisher value="Health Level Seven, Inc. - CQI WG"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/special/committees/CQI"/> </telecom> </contact> <description value="Profile of Family History for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors."/> <status value="draft"/> <date value="2015-02-27"/> <mapping> <identity value="qdm"/> <uri value="http://www.healthit.gov/quality-data-model"/> <name value="Quality Data Model"/> </mapping> <type value="constraint"/> <abstract value="false"/> <base value="http://hl7.org/fhir/StructureDefinition/FamilyHistory"/> <snapshot> <element> <path value="FamilyHistory"/> <name value="QICore-FamilyHistory"/> <short value="Information about patient's relatives, relevant for patient"/> <definition 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="FamilyHistory"/> </type> <mapping> <identity value="v2"/> <map value="Not in scope for v2"/> </mapping> <mapping> <identity value="rim"/> <map value="Observation[classCode=OBS, moodCode=EVN]"/> </mapping> <mapping> <identity value="qdm"/> <map value="Diagnosis, Family History"/> </mapping> </element> <element> <path value="FamilyHistory.id"/> <short value="Logical id of this artefact"/> <definition value="The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes."/> <comments value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> </element> <element> <path value="FamilyHistory.meta"/> <short value="Metadata about the resource"/> <definition value="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."/> <min value="0"/> <max value="1"/> <type> <code value="Meta"/> </type> </element> <element> <path value="FamilyHistory.implicitRules"/> <short value="A set of rules under which this content was created"/> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content."/> <comments value="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 as much as possible."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="true"/> </element> <element> <path value="FamilyHistory.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comments value="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)."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="Language"/> <strength value="required"/> <description value="A human language"/> <valueSetUri value="http://tools.ietf.org/html/bcp47"/> </binding> </element> <element> <path value="FamilyHistory.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition 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."/> <alias value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <condition value="dom-1"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element> <path value="FamilyHistory.contained"/> <short value="Contained, inline Resources"/> <definition 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."/> <alias value="inline resources"/> <alias value="anonymous resources"/> <alias value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="FamilyHistory.extension"/> <short value="Additional Content defined by implementations"/> <definition 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 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."/> <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 level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="FamilyHistory.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition 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 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."/> <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 level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="FamilyHistory.identifier"/> <short value="External Id(s) for this record"/> <definition 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)."/> <requirements value="Need to allow connection to a wider workflow."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="id"/> </mapping> </element> <element> <path value="FamilyHistory.patient"/> <short value="Patient history is about"/> <definition value="The person who this history concerns."/> <alias value="Proband"/> <min value="1"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/patient-qicore-qicore-patient"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=SBJ].role"/> </mapping> </element> <element> <path value="FamilyHistory.date"/> <short value="When history was captured/updated"/> <definition value="The date (and possibly time) when the family history was taken."/> <requirements value="Allows determination of how current the summary is."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=AUT].time"/> </mapping> </element> <element> <path value="FamilyHistory.note"/> <short value="Additional details not covered elsewhere"/> <definition value="Conveys information about family history not specific to individual relations."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"/> </mapping> </element> <element> <path value="FamilyHistory.relation"/> <short value="Relative described by history"/> <definition value="The related person. Each FamilyHistory resource contains the entire family history for a single person."/> <min value="0"/> <max value="*"/> <constraint> <key value="fhs-1"/> <name value="Age or Birthdate"/> <severity value="error"/> <human value="Can have age[x] or birth[x], but not both"/> <xpath value="not (*[starts-with(local-name(.), 'age')] and *[starts-with(local-name(.), 'birth')])"/> </constraint> <mapping> <identity value="rim"/> <map value="participation[typeCode=SBJ].role[classCode=PAT].player[classCode<LIV, moodCode=INSTANCE].scopedRo le"/> </mapping> </element> <element> <path value="FamilyHistory.relation.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="FamilyHistory.relation.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <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 level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="FamilyHistory.relation.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <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 level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="FamilyHistory.relation.name"/> <short value="The family member described"/> <definition value="This will either be a name or a description. E.g. "Aunt Susan", "my cousin with the red hair"."/> <requirements value="Allows greater ease in ensuring the same person is being talked about."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="name"/> </mapping> </element> <element> <path value="FamilyHistory.relation.relationship"/> <short value="Relationship to the subject"/> <definition 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> <mustSupport value="true"/> <isSummary value="true"/> <binding> <name value="FamilialRelationship"/> <strength value="required"/> <description value="The nature of the relationship between the patient and the related person being described in the family history"/> <valueSetReference> <reference value="http://hl7.org/fhir/v3/vs/FamilyMember"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value="code"/> </mapping> </element> <element> <path value="FamilyHistory.relation.born[x]"/> <short value="(approximate) date of birth"/> <definition value="The actual or approximate date of birth of the relative."/> <requirements value="Allows calculation of the relative's age."/> <min value="0"/> <max value="1"/> <type> <code value="Period"/> </type> <type> <code value="date"/> </type> <type> <code value="string"/> </type> <condition value="fhs-1"/> <mapping> <identity value="rim"/> <map value="player[classCode=LIV, determinerCode=INSTANCE]. birthDate (could be URG)"/> </mapping> </element> <element> <path value="FamilyHistory.relation.age[x]"/> <short value="(approximate) age"/> <definition value="The actual or approximate age of the relative at the time the family history is recorded."/> <requirements value="While age can be calculated from date of birth, sometimes recording age directly is more natureal for clinicians."/> <min value="0"/> <max value="1"/> <type> <code value="Age"/> </type> <type> <code value="Range"/> </type> <type> <code value="string"/> </type> <condition value="fhs-1"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=SBJ].act[classCode=OBS,moodCode=EVN, code="age"].value"/> </mapping> </element> <element> <path value="FamilyHistory.relation.deceased[x]"/> <short value="Dead? How old/when?"/> <definition 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> <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> </element> <element> <path value="FamilyHistory.relation.note"/> <short value="General note about related person"/> <definition 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> <mapping> <identity value="rim"/> <map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"/> </mapping> </element> <element> <path value="FamilyHistory.relation.condition"/> <short value="Condition that the related person had"/> <definition 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."/> <comments value="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."/> <min value="0"/> <max value="*"/> <mapping> <identity value="rim"/> <map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION, value<Diagnosis]"/> </mapping> </element> <element> <path value="FamilyHistory.relation.condition.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="FamilyHistory.relation.condition.extension"/> <slicing> <discriminator value="url"/> <ordered value="false"/> <rules value="open"/> </slicing> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> </element> <element> <path value="FamilyHistory.relation.condition.extension"/> <name value="FamilyHistory.relation.condition.abatement"/> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="1"/> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/StructureDefinition/familyhistory-abatement"/> </type> <mapping> <identity value="qdm"/> <map value="stop datetime"/> </mapping> </element> <element> <path value="FamilyHistory.relation.condition.extension"/> <name value="FamilyHistory.relation.condition.didNotHave"/> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="1"/> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/StructureDefinition/familyhistory-didNotHave"/> </type> <mapping> <identity value="qdm"/> <map value="negation rationale"/> </mapping> </element> <element> <path value="FamilyHistory.relation.condition.extension"/> <name value="FamilyHistory.relation.condition.severity"/> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="1"/> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/StructureDefinition/familyhistory-severity"/> </type> <mapping> <identity value="qdm"/> <map value="severity"/> </mapping> </element> <element> <path value="FamilyHistory.relation.condition.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <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 level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="FamilyHistory.relation.condition.type"/> <short value="Condition suffered by relation"/> <definition 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> <mustSupport value="true"/> <mapping> <identity value="rim"/> <map value=".value"/> </mapping> <mapping> <identity value="qdm"/> <map value="primary code"/> </mapping> </element> <element> <path value="FamilyHistory.relation.condition.outcome"/> <short value="deceased | permanent disability | etc."/> <definition 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> <binding> <name value="ConditionOutcome"/> <strength value="required"/> <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> <mapping> <identity value="qdm"/> <map value="status"/> </mapping> </element> <element> <path value="FamilyHistory.relation.condition.onset[x]"/> <short value="When condition first manifested"/> <definition 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."/> <requirements value="Age of onset of a condition in relatives is predictive of risk for the patient."/> <min value="0"/> <max value="1"/> <type> <code value="Age"/> </type> <type> <code value="Range"/> </type> <type> <code value="string"/> </type> <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> <mapping> <identity value="qdm"/> <map value="start datetime"/> </mapping> </element> <element> <path value="FamilyHistory.relation.condition.note"/> <short value="Extra information about condition"/> <definition value="An area where general notes can be placed about this specific condition."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"/> </mapping> </element> </snapshot> <differential> <element> <path value="FamilyHistory"/> <name value="QICore-FamilyHistory"/> <min value="1"/> <max value="1"/> <type> <code value="FamilyHistory"/> </type> <mapping> <identity value="qdm"/> <map value="Diagnosis, Family History"/> </mapping> </element> <element> <path value="FamilyHistory.patient"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/patient-qicore-qicore-patient"/> </type> <mustSupport value="true"/> </element> <element> <path value="FamilyHistory.date"/> <mustSupport value="true"/> </element> <element> <path value="FamilyHistory.relation"/> </element> <element> <path value="FamilyHistory.relation.relationship"/> <mustSupport value="true"/> </element> <element> <path value="FamilyHistory.relation.condition"/> </element> <element> <path value="FamilyHistory.relation.condition.extension"/> <slicing> <discriminator value="url"/> <ordered value="false"/> <rules value="open"/> </slicing> </element> <element> <path value="FamilyHistory.relation.condition.extension"/> <name value="FamilyHistory.relation.condition.abatement"/> <min value="0"/> <max value="1"/> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/StructureDefinition/familyhistory-abatement"/> </type> <mapping> <identity value="qdm"/> <map value="stop datetime"/> </mapping> </element> <element> <path value="FamilyHistory.relation.condition.extension"/> <name value="FamilyHistory.relation.condition.didNotHave"/> <min value="0"/> <max value="1"/> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/StructureDefinition/familyhistory-didNotHave"/> </type> <mapping> <identity value="qdm"/> <map value="negation rationale"/> </mapping> </element> <element> <path value="FamilyHistory.relation.condition.extension"/> <name value="FamilyHistory.relation.condition.severity"/> <min value="0"/> <max value="1"/> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/StructureDefinition/familyhistory-severity"/> </type> <mapping> <identity value="qdm"/> <map value="severity"/> </mapping> </element> <element> <path value="FamilyHistory.relation.condition.type"/> <mustSupport value="true"/> <mapping> <identity value="qdm"/> <map value="primary code"/> </mapping> </element> <element> <path value="FamilyHistory.relation.condition.outcome"/> <mapping> <identity value="qdm"/> <map value="status"/> </mapping> </element> <element> <path value="FamilyHistory.relation.condition.onset[x]"/> <mapping> <identity value="qdm"/> <map value="start datetime"/> </mapping> </element> </differential> </StructureDefinition>