{ "resourceType": "StructureDefinition", "id": "FamilyMemberHistory", "meta": { "lastUpdated": "2024-10-17T01:54:34.4898651+00:00" }, "text": { "status": "generated", "div": "
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\"FamilyMemberHistoryITUDomainResourceInformation about patient's relatives, relevant for patient\n
+ Rule: Can have age[x] or born[x], but not both
+ Rule: Can only have estimatedAge if age[x] is present
Elements defined in Ancestors: \n id, \n meta, \n implicitRules, \n language, \n text, \n contained, \n extension, \n modifierExtension
\".\"\".\"\".\"identifierΣ0..*IdentifierExternal Id(s) for this record\n
\".\"\".\"\".\"instantiatesCanonicalΣ0..*canonical(\n PlanDefinition | \n Questionnaire | \n ActivityDefinition | \n Measure | \n OperationDefinition)\n Instantiates FHIR protocol or definition\n
\".\"\".\"\".\"instantiatesUriΣ0..*uriInstantiates external protocol or definition\n
\".\"\".\"\".\"status?!Σ1..1codepartial | completed | entered-in-error | health-unknown\n
FamilyHistoryStatus (\n Required)\n
\".\"\".\"\".\"dataAbsentReasonΣ0..1CodeableConceptsubject-unknown | withheld | unable-to-obtain | deferred\n
FamilyHistoryAbsentReason (\n Example)\n
\".\"\".\"\".\"patientΣ1..1Reference(\n Patient)\n Patient history is about
\".\"\".\"\".\"dateΣ0..1dateTimeWhen history was recorded or last updated
\".\"\".\"\".\"nameΣ0..1stringThe family member described
\".\"\".\"\".\"relationshipΣ1..1CodeableConceptRelationship to the subject\n
V3 Value SetFamilyMember (\n Example)\n
\".\"\".\"\".\"sexΣ0..1CodeableConceptmale | female | other | unknown\n
Sex (\n Extensible)\n
\".\"\".\"\".\"born[x]I0..1(approximate) date of birth
\".\"\".\"\".\"\".\"bornPeriodPeriod
\".\"\".\"\".\"\".\"bornDatedate
\".\"\".\"\".\"\".\"bornStringstring
\".\"\".\"\".\"age[x]ΣI0..1(approximate) age
\".\"\".\"\".\"\".\"ageAgeAge
\".\"\".\"\".\"\".\"ageRangeRange
\".\"\".\"\".\"\".\"ageStringstring
\".\"\".\"\".\"estimatedAgeΣI0..1booleanAge is estimated?
\".\"\".\"\".\"deceased[x]Σ0..1Dead? How old/when?
\".\"\".\"\".\"\".\"deceasedBooleanboolean
\".\"\".\"\".\"\".\"deceasedAgeAge
\".\"\".\"\".\"\".\"deceasedRangeRange
\".\"\".\"\".\"\".\"deceasedDatedate
\".\"\".\"\".\"\".\"deceasedStringstring
\".\"\".\"\".\"reasonCodeΣ0..*CodeableConceptWhy was family member history performed?\n
SNOMED CT Clinical Findings (\n Example)\n
\".\"\".\"\".\"reasonReferenceΣ0..*Reference(\n Condition | \n Observation | \n AllergyIntolerance | \n QuestionnaireResponse | \n DiagnosticReport | \n DocumentReference)\n Why was family member history performed?\n
\".\"\".\"\".\"note0..*AnnotationGeneral note about related person\n
\".\"\".\"\".\"condition0..*BackboneElementCondition that the related person had\n
\".\"\".\"\".\"\".\"code1..1CodeableConceptCondition suffered by relation\n
Condition/Problem/Diagnosis Codes (\n Example)\n
\".\"\".\"\".\"\".\"outcome0..1CodeableConceptdeceased | permanent disability | etc.\n
Condition Outcome Codes (\n Example)\n
\".\"\".\"\".\"\".\"contributedToDeath0..1booleanWhether the condition contributed to the cause of death
\".\"\".\"\".\"\".\"onset[x]0..1When condition first manifested
\".\"\".\"\".\"\".\"\".\"onsetAgeAge
\".\"\".\"\".\"\".\"\".\"onsetRangeRange
\".\"\".\"\".\"\".\"\".\"onsetPeriodPeriod
\".\"\".\"\".\"\".\"\".\"onsetStringstring
\".\"\".\"\".\"\".\"note0..*AnnotationExtra information about condition\n

\"doco\" Documentation for this format\n
" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category", "valueString": "Clinical.Summary" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 2 }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category", "valueCode": "patient" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "pc" } ], "url": "https://simplifier.net/omd-cdss/familymemberhistoryprofile", "version": "4.0.0", "name": "FamilyMemberHistoryProfile", "title": "Family Member History Profile", "status": "draft", "date": "2021-04-19T13:48:45.9513368+00:00", "publisher": "OMD", "contact": [ { "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/patientcare/index.cfm" } ] }, { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Significant health conditions for a person related to the patient relevant in the context of care for the patient.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "CDSS5.1", "uri": "www.ontariomd.com", "name": "CDS-S 5.1" } ], "kind": "resource", "abstract": false, "type": "FamilyMemberHistory", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource", "derivation": "specialization", "differential": { "element": [ { "id": "FamilyMemberHistory", "path": "FamilyMemberHistory", "short": "Information about patient's relatives, relevant for patient", "definition": "Significant health conditions for a person related to the patient relevant in the context of care for the patient.", "constraint": [ { "key": "fhs-2", "severity": "error", "human": "Can only have estimatedAge if age[x] is present", "expression": "age.exists() or estimatedAge.empty()", "xpath": "exists(*[starts-with(local-name(.), 'age')]) or not(exists(f:estimatedAge))", "source": "http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory" }, { "key": "fhs-1", "severity": "error", "human": "Can have age[x] or born[x], but not both", "expression": "age.empty() or born.empty()", "xpath": "not (*[starts-with(local-name(.), 'age')] and *[starts-with(local-name(.), 'birth')])", "source": "http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory" } ], "mapping": [ { "identity": "workflow", "map": "Event" }, { "identity": "v2", "map": "Not in scope for v2" }, { "identity": "rim", "map": "Observation[classCode=OBS, moodCode=EVN]" } ] }, { "id": "FamilyMemberHistory.identifier", "path": "FamilyMemberHistory.identifier", "short": "External Id(s) for this record", "definition": "Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", "comment": "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.", "requirements": "Allows identification of the family member history as it is known by various participating systems and in a way that remains consistent across servers.", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "rim", "map": "id" } ] }, { "id": "FamilyMemberHistory.instantiatesCanonical", "path": "FamilyMemberHistory.instantiatesCanonical", "short": "Instantiates FHIR protocol or definition", "definition": "The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.", "type": [ { "code": "canonical", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/PlanDefinition", "http://hl7.org/fhir/StructureDefinition/Questionnaire", "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", "http://hl7.org/fhir/StructureDefinition/Measure", "http://hl7.org/fhir/StructureDefinition/OperationDefinition" ] } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.instantiatesCanonical" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ] }, { "id": "FamilyMemberHistory.instantiatesUri", "path": "FamilyMemberHistory.instantiatesUri", "short": "Instantiates external protocol or definition", "definition": "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.", "comment": "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.instantiatesUri" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ] }, { "id": "FamilyMemberHistory.status", "path": "FamilyMemberHistory.status", "short": "partial | completed | entered-in-error | health-unknown", "definition": "A code specifying the status of the record of the family history of a specific family member.", "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "type": [ { "code": "code" } ], "isModifier": true, "isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FamilyHistoryStatus" } ], "strength": "required", "description": "A code that identifies the status of the family history record.", "valueSet": "http://hl7.org/fhir/ValueSet/history-status|4.0.0" }, "mapping": [ { "identity": "workflow", "map": "Event.status" }, { "identity": "w5", "map": "FiveWs.status" } ] }, { "id": "FamilyMemberHistory.dataAbsentReason", "path": "FamilyMemberHistory.dataAbsentReason", "short": "subject-unknown | withheld | unable-to-obtain | deferred", "definition": "Describes why the family member's history is not available.", "requirements": "This is a separate element to allow it to have a distinct binding from reasonCode.", "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FamilyHistoryAbsentReason" } ], "strength": "example", "description": "Codes describing the reason why a family member's history is not available.", "valueSet": "http://hl7.org/fhir/ValueSet/history-absent-reason" }, "mapping": [ { "identity": "rim", "map": ".reasonCode" } ] }, { "id": "FamilyMemberHistory.patient", "path": "FamilyMemberHistory.patient", "short": "Patient history is about", "definition": "The person who this history concerns.", "alias": [ "Proband" ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ] } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.subject" }, { "identity": "w5", "map": "FiveWs.subject[x]" }, { "identity": "rim", "map": "participation[typeCode=SBJ].role" }, { "identity": "w5", "map": "FiveWs.subject" } ] }, { "id": "FamilyMemberHistory.date", "path": "FamilyMemberHistory.date", "short": "When history was recorded or last updated", "definition": "The date (and possibly time) when the family member history was recorded or last updated.", "comment": "This should be captured even if the same as the date on the List aggregating the full family history.", "requirements": "Allows determination of how current the summary is.", "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.recorded" }, { "identity": "rim", "map": "participation[typeCode=AUT].time" } ] }, { "id": "FamilyMemberHistory.name", "path": "FamilyMemberHistory.name", "short": "The family member described", "definition": "This will either be a name or a description; e.g. \"Aunt Susan\", \"my cousin with the red hair\".", "requirements": "Allows greater ease in ensuring the same person is being talked about.", "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "name" } ] }, { "id": "FamilyMemberHistory.relationship", "path": "FamilyMemberHistory.relationship", "short": "Relationship to the subject", "definition": "The type of relationship this person has to the patient (father, mother, brother etc.).", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FamilialRelationship" } ], "strength": "example", "description": "The nature of the relationship between the patient and the related person being described in the family member history.", "valueSet": "http://terminology.hl7.org/ValueSet/v3-FamilyMember" }, "mapping": [ { "identity": "rim", "map": "code" } ] }, { "id": "FamilyMemberHistory.relationship.coding.code", "path": "FamilyMemberHistory.relationship.coding.code", "definition": "BASE RESOURCE DEFINITION: \r\nA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).\r\n\r\nCDS-S PROFILE DEFINITION: \r\nRelationship to the family member that is blood related to the patient.", "mustSupport": true, "mapping": [ { "identity": "CDSS5.1", "map": "DE05.006", "comment": "Relationship" } ] }, { "id": "FamilyMemberHistory.sex", "path": "FamilyMemberHistory.sex", "short": "male | female | other | unknown", "definition": "The birth sex of the family member.", "comment": "This element should ideally reflect whether the individual is genetically male or female. However, as reported information based on the knowledge of the patient or reporting friend/relative, there may be situations where the reported sex might not be totally accurate. E.g. 'Aunt Sue' might be XY rather than XX. Questions soliciting this information should be phrased to encourage capture of genetic sex where known. However, systems performing analysis should also allow for the possibility of imprecision with this element.", "requirements": "Not all relationship codes imply sex and the relative's sex can be relevant for risk assessments.", "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Sex" } ], "strength": "extensible", "description": "Codes describing the sex assigned at birth as documented on the birth registration.", "valueSet": "http://build.fhir.org/valueset-administrative-gender.html" } }, { "id": "FamilyMemberHistory.born[x]", "path": "FamilyMemberHistory.born[x]", "short": "(approximate) date of birth", "definition": "The actual or approximate date of birth of the relative.", "requirements": "Allows calculation of the relative's age.", "max": "1", "type": [ { "code": "Period" }, { "code": "date" }, { "code": "string" } ], "condition": [ "fhs-1" ], "mapping": [ { "identity": "rim", "map": "player[classCode=LIV, determinerCode=INSTANCE]. birthDate (could be URG)" } ] }, { "id": "FamilyMemberHistory.age[x]", "path": "FamilyMemberHistory.age[x]", "short": "(approximate) age", "definition": "The age of the relative at the time the family member history is recorded.", "comment": "use estimatedAge to indicate whether the age is actual or not.", "requirements": "While age can be calculated from date of birth, sometimes recording age directly is more natural for clinicians.", "max": "1", "type": [ { "code": "Age" }, { "code": "Range" }, { "code": "string" } ], "condition": [ "fhs-1" ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "participation[typeCode=SBJ].act[classCode=OBS,moodCode=EVN, code=\"age\"].value" } ] }, { "id": "FamilyMemberHistory.estimatedAge", "path": "FamilyMemberHistory.estimatedAge", "short": "Age is estimated?", "definition": "If true, indicates that the age value specified is an estimated value.", "comment": "This element is labeled as a modifier because the fact that age is estimated can/should change the results of any algorithm that calculates based on the specified age.", "requirements": "Clinicians often prefer to specify an estimaged age rather than an age range.", "max": "1", "type": [ { "code": "boolean" } ], "meaningWhenMissing": "It is unknown whether the age is an estimate or not", "condition": [ "fhs-2" ], "isSummary": true }, { "id": "FamilyMemberHistory.deceased[x]", "path": "FamilyMemberHistory.deceased[x]", "short": "Dead? How old/when?", "definition": "Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.", "max": "1", "type": [ { "code": "boolean" }, { "code": "Age" }, { "code": "Range" }, { "code": "date" }, { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "player[classCode=LIV, determinerCode=INSTANCE].deceasedInd, deceasedDate (could be URG) For age, you'd hang an observation off the role" } ] }, { "id": "FamilyMemberHistory.reasonCode", "path": "FamilyMemberHistory.reasonCode", "short": "Why was family member history performed?", "definition": "Describes why the family member history occurred in coded or textual form.", "comment": "Textual reasons can be captured using reasonCode.text.", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FamilyHistoryReason" } ], "strength": "example", "description": "Codes indicating why the family member history was done.", "valueSet": "http://hl7.org/fhir/ValueSet/clinical-findings" }, "mapping": [ { "identity": "workflow", "map": "Event.reasonCode" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "rim", "map": ".reasonCode" } ] }, { "id": "FamilyMemberHistory.reasonReference", "path": "FamilyMemberHistory.reasonReference", "short": "Why was family member history performed?", "definition": "Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Condition", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance", "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse", "http://hl7.org/fhir/StructureDefinition/DiagnosticReport", "http://hl7.org/fhir/StructureDefinition/DocumentReference" ] } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.reasonReference" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=RSON].target" } ] }, { "id": "FamilyMemberHistory.note", "path": "FamilyMemberHistory.note", "short": "General note about related person", "definition": "BASE RESOURCE DEFINITION: \r\nThis 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.\r\n\r\nCDS-S PROFILE DEFINITION: \r\nAdditional notes about family member history of a problem, diagnosis or procedure.", "type": [ { "code": "Annotation" } ], "mustSupport": true, "mapping": [ { "identity": "workflow", "map": "Event.note" }, { "identity": "rim", "map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value" }, { "identity": "CDSS5.1", "map": "DE05.007", "comment": "Notes" } ] }, { "id": "FamilyMemberHistory.condition", "path": "FamilyMemberHistory.condition", "short": "Condition that the related person had", "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.", "type": [ { "code": "BackboneElement" } ], "mapping": [ { "identity": "rim", "map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION, value