- This version of the UK Core is for C&TA Sprint 7 Review.
- This version is not suitable for implementation. Other versions are available on the UK Core Version History Guide
- Please follow the guidance on the Contact Us page if you need any assistance.
- A summary of changes is available on the STU3 Sequence Change Log
StructureDefinition-UKCore-FamilyMemberHistory
Canonical_URL | Current_Version | Last_Updated | Description |
---|---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/UKCore-FamilyMemberHistory | 1.1.0 | 2023-04-28 | This profile defines the UK constraints and extensions on the International FHIR resource FamilyMemberHistory. |
Profile_Purpose |
---|
This profile allows exchange of information about health events and conditions for a person related to the patient relevant in the context of care. |
Table View
FamilyMemberHistory | .. | |
FamilyMemberHistory.extension | 0.. | |
FamilyMemberHistory.extension | Extension | 0.. |
FamilyMemberHistory.extension | Extension | 0.. |
FamilyMemberHistory.extension.extension | 1.. | |
FamilyMemberHistory.extension.extension | 0.. | |
FamilyMemberHistory.extension.extension.value[x] | .. | |
FamilyMemberHistory.extension.extension | 1.. | |
FamilyMemberHistory.extension.extension.value[x] | .. | |
FamilyMemberHistory.identifier | .. | |
FamilyMemberHistory.identifier.assigner | Reference(UK Core Organization) | .. |
FamilyMemberHistory.instantiatesCanonical | canonical(PlanDefinition | UK Core Questionnaire | ActivityDefinition | Measure | OperationDefinition) | .. |
FamilyMemberHistory.dataAbsentReason | .. | |
FamilyMemberHistory.patient | Reference(UK Core Patient) | .. |
FamilyMemberHistory.relationship | .. | |
FamilyMemberHistory.reasonReference | Reference(UK Core Condition | UK Core Observation | UK Core AllergyIntolerance | UK Core QuestionnaireResponse | UK Core DiagnosticReport | UK Core DocumentReference) | .. |
FamilyMemberHistory.note | .. | |
FamilyMemberHistory.note.author[x] | Reference(UK Core Practitioner | UK Core Patient | UK Core RelatedPerson | UK Core Organization), string | .. |
FamilyMemberHistory.condition | .. | |
FamilyMemberHistory.condition.code | .. | |
FamilyMemberHistory.condition.outcome | .. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="UKCore-FamilyMemberHistory" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-FamilyMemberHistory" /> <version value="1.1.0" /> <name value="UKCoreFamilyMemberHistory" /> <title value="UKCore FamilyMemberHistory" /> <status value="active" /> <date value="2023-04-28" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="ukcore@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="This profile defines the UK constraints and extensions on the International FHIR resource [FamilyMemberHistory](https://hl7.org/fhir/R4/familymemberhistory.html)." /> <purpose value="This profile allows exchange of information about health events and conditions for a person related to the patient relevant in the context of care." /> <copyright value="Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="FamilyMemberHistory" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory" /> <derivation value="constraint" /> <differential> <element id="FamilyMemberHistory.extension"> <path value="FamilyMemberHistory.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <rules value="open" /> </slicing> <min value="0" /> </element> <element id="FamilyMemberHistory.extension:associatedEncounter"> <path value="FamilyMemberHistory.extension" /> <sliceName value="associatedEncounter" /> <min value="0" /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AssociatedEncounter" /> </type> <isModifier value="false" /> </element> <element id="FamilyMemberHistory.extension:participantR5"> <path value="FamilyMemberHistory.extension" /> <sliceName value="participantR5" /> <short value="Who or what participated in the activities related to the family member history. This is a R5 backport." /> <definition value="An extension to record who or what participated in the activities related to the family member history." /> <min value="0" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/5.0/StructureDefinition/extension-FamilyMemberHistory.participant" /> </type> <isModifier value="false" /> </element> <element id="FamilyMemberHistory.extension:participantR5.extension"> <path value="FamilyMemberHistory.extension.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <rules value="open" /> </slicing> <min value="1" /> </element> <element id="FamilyMemberHistory.extension:participantR5.extension:function"> <path value="FamilyMemberHistory.extension.extension" /> <sliceName value="function" /> <min value="0" /> </element> <element id="FamilyMemberHistory.extension:participantR5.extension:function.value[x]"> <path value="FamilyMemberHistory.extension.extension.value[x]" /> <short value="The type of involvement in the activities related to the family member history" /> <definition value="This FHIR value set is comprised of Actor participation Type codes, which can be used to value FHIR agents, actors, and other role elements. The codes are intended to express how the agent participated in some activity. Sometimes referred to the agent functional-role relative to the activity." /> </element> <element id="FamilyMemberHistory.extension:participantR5.extension:actor"> <path value="FamilyMemberHistory.extension.extension" /> <sliceName value="actor" /> <min value="1" /> </element> <element id="FamilyMemberHistory.extension:participantR5.extension:actor.value[x]"> <path value="FamilyMemberHistory.extension.extension.value[x]" /> <short value="Who or what participated in the activities related to the family member history" /> <definition value="A reference to a Patient, Practitioner, PractitionerRole, RelatedPerson, Device, Organization, or CareTeam." /> </element> <element id="FamilyMemberHistory.identifier.assigner"> <path value="FamilyMemberHistory.identifier.assigner" /> <type> <code value="Reference" /> <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" /> </type> </element> <element id="FamilyMemberHistory.instantiatesCanonical"> <path value="FamilyMemberHistory.instantiatesCanonical" /> <type> <code value="canonical" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PlanDefinition" /> <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Questionnaire" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ActivityDefinition" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Measure" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/OperationDefinition" /> </type> </element> <element id="FamilyMemberHistory.dataAbsentReason"> <path value="FamilyMemberHistory.dataAbsentReason" /> <binding> <strength value="extensible" /> </binding> </element> <element id="FamilyMemberHistory.patient"> <path value="FamilyMemberHistory.patient" /> <type> <code value="Reference" /> <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" /> </type> </element> <element id="FamilyMemberHistory.relationship"> <path value="FamilyMemberHistory.relationship" /> <binding> <strength value="extensible" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType" /> </binding> </element> <element id="FamilyMemberHistory.reasonReference"> <path value="FamilyMemberHistory.reasonReference" /> <type> <code value="Reference" /> <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition" /> <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation" /> <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance" /> <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse" /> <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport" /> <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference" /> </type> </element> <element id="FamilyMemberHistory.note.author[x]"> <path value="FamilyMemberHistory.note.author[x]" /> <type> <code value="Reference" /> <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" /> <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" /> <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" /> <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" /> </type> <type> <code value="string" /> </type> </element> <element id="FamilyMemberHistory.condition.code"> <path value="FamilyMemberHistory.condition.code" /> <binding> <strength value="preferred" /> </binding> </element> <element id="FamilyMemberHistory.condition.outcome"> <path value="FamilyMemberHistory.condition.outcome" /> <binding> <strength value="preferred" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "UKCore-FamilyMemberHistory", "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-FamilyMemberHistory", "version": "1.1.0", "name": "UKCoreFamilyMemberHistory", "title": "UKCore FamilyMemberHistory", "status": "active", "date": "2023-04-28", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "ukcore@hl7.org.uk", "use": "work", "rank": 1 } ] } ], "description": "This profile defines the UK constraints and extensions on the International FHIR resource [FamilyMemberHistory](https://hl7.org/fhir/R4/familymemberhistory.html).", "purpose": "This profile allows exchange of information about health events and conditions for a person related to the patient relevant in the context of care.", "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "FamilyMemberHistory", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory", "derivation": "constraint", "differential": { "element": [ { "id": "FamilyMemberHistory.extension", "path": "FamilyMemberHistory.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" }, "min": 0 }, { "id": "FamilyMemberHistory.extension:associatedEncounter", "path": "FamilyMemberHistory.extension", "sliceName": "associatedEncounter", "min": 0, "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AssociatedEncounter" ] } ], "isModifier": false }, { "id": "FamilyMemberHistory.extension:participantR5", "path": "FamilyMemberHistory.extension", "sliceName": "participantR5", "short": "Who or what participated in the activities related to the family member history. This is a R5 backport.", "definition": "An extension to record who or what participated in the activities related to the family member history.", "min": 0, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/5.0/StructureDefinition/extension-FamilyMemberHistory.participant" ] } ], "isModifier": false }, { "id": "FamilyMemberHistory.extension:participantR5.extension", "path": "FamilyMemberHistory.extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" }, "min": 1 }, { "id": "FamilyMemberHistory.extension:participantR5.extension:function", "path": "FamilyMemberHistory.extension.extension", "sliceName": "function", "min": 0 }, { "id": "FamilyMemberHistory.extension:participantR5.extension:function.value[x]", "path": "FamilyMemberHistory.extension.extension.value[x]", "short": "The type of involvement in the activities related to the family member history", "definition": "This FHIR value set is comprised of Actor participation Type codes, which can be used to value FHIR agents, actors, and other role elements. The codes are intended to express how the agent participated in some activity. Sometimes referred to the agent functional-role relative to the activity." }, { "id": "FamilyMemberHistory.extension:participantR5.extension:actor", "path": "FamilyMemberHistory.extension.extension", "sliceName": "actor", "min": 1 }, { "id": "FamilyMemberHistory.extension:participantR5.extension:actor.value[x]", "path": "FamilyMemberHistory.extension.extension.value[x]", "short": "Who or what participated in the activities related to the family member history", "definition": "A reference to a Patient, Practitioner, PractitionerRole, RelatedPerson, Device, Organization, or CareTeam." }, { "id": "FamilyMemberHistory.identifier.assigner", "path": "FamilyMemberHistory.identifier.assigner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" ] } ] }, { "id": "FamilyMemberHistory.instantiatesCanonical", "path": "FamilyMemberHistory.instantiatesCanonical", "type": [ { "code": "canonical", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/PlanDefinition", "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Questionnaire", "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", "http://hl7.org/fhir/StructureDefinition/Measure", "http://hl7.org/fhir/StructureDefinition/OperationDefinition" ] } ] }, { "id": "FamilyMemberHistory.dataAbsentReason", "path": "FamilyMemberHistory.dataAbsentReason", "binding": { "strength": "extensible" } }, { "id": "FamilyMemberHistory.patient", "path": "FamilyMemberHistory.patient", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" ] } ] }, { "id": "FamilyMemberHistory.relationship", "path": "FamilyMemberHistory.relationship", "binding": { "strength": "extensible", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType" } }, { "id": "FamilyMemberHistory.reasonReference", "path": "FamilyMemberHistory.reasonReference", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition", "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation", "https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance", "https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse", "https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport", "https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference" ] } ] }, { "id": "FamilyMemberHistory.note.author[x]", "path": "FamilyMemberHistory.note.author[x]", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner", "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient", "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson", "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" ] }, { "code": "string" } ] }, { "id": "FamilyMemberHistory.condition.code", "path": "FamilyMemberHistory.condition.code", "binding": { "strength": "preferred" } }, { "id": "FamilyMemberHistory.condition.outcome", "path": "FamilyMemberHistory.condition.outcome", "binding": { "strength": "preferred" } } ] } }
Examples
Associated Encounter - An example to illustrate using the extension to indicate the encounter for which the family members condition was recorded.Example UKCore-Extension-AssociatedEncounter
Father with Diabetes - An example to illustrate the the use of FamilyMemberHistory to record a father with diabetes.
Example UKCore-FamilyMemberHistory-FatherDiabetes
Participant Reference - An example to illustrate the pre-adopted R5 element via an extension, which is used to indicate the performer of the family member history related activity.
Example UKCore-Extension-Participant
Usage
This Profile has the following derived profiles:This Profile is referenced in the following Extensions:
This Profile is referenced in the following Profiles:
Example Usage Scenarios
The following are example usage scenarios for the UK Core FamilyMemberHistory profile:
- Query for details of a FamilyMemberHistory
- Exchange FamilyMemberHistory information within a FHIR document or message.
Profile Specific Implementation Guidance:
Minimum Viable Content
A minimum viable content that all provider and consumer systems SHALL support are the following elements.
Element | Reason |
---|---|
FamilyMemberHistory.status |
A code specifying the status of the record of the family history of a specific family member. |
FamilyMemberHistory.patient |
The person who this history concerns. |
FamilyMemberHistory.date |
The date (and possibly time) when the family member history was recorded or last updated. |
FamilyMemberHistory.name |
Allows greater ease in ensuring the same person is being talked about. |
FamilyMemberHistory.relationship |
Relationship to the subject. |
FamilyMemberHistory.sex |
The birth sex of the family member. |
FamilyMemberHistory.condition |
Condition that the related person had. |
Extensions
More information about the extensions can be found using the links below.
Extension | Context | Link | Comment |
---|---|---|---|
AssociatedEncounter | FamilyMemberHistory | Extension UKCore-AssociatedEncounter | This extension is used to reference an associated encounter. |
participantR5 | FamilyMemberHistory | Extension UKCore-Participant | This extension is a pre-adopted R5 element, for more details, see Pre-adopted R5 Elements. |
Bindings (differential)
More information about the bindings to UK Core ValueSets can be found below.
Context | Strength | Link |
---|---|---|
FamilyMemberHistory.relationship | Extensible | ValueSet UKCore-PersonRelationshipType |
instantiatesCanonical
The resource being referenced SHALL conform to the following:
- ActivityDefinition Resource
- Measure Resource
- OperationDefinition Resource
- PlanDefinition Resource
- Profile UKCore-Questionnaire
relationship
FamilyMemberHistory.relationship
has an Extensible binding to ValueSet UKCore-PersonRelationshipType. It is expected that only relationships that define a biological link between family members SHOULD be used.
reasonReference
The resource being referenced SHALL conform to the following:
- Profile UKCore-AllergyIntolerance
- Profile UKCore-Condition
- Profile UKCore-DiagnosticReport
- Profile UKCore-DocumentReference
- Profile UKCore-Observation
- Profile UKCore-QuestionnaireResponse
note
The resource being referenced by FamilyMemberHistory.note.authorReference
SHALL conform to one of the following:
- Profile UKCore-Organization
- Profile UKCore-Patient
- Profile UKCore-Practitioner
- Profile UKCore-RelatedPerson