UK Core Implementation Guide STU3 Sequence

Please note:

This version of the UK Core is a development copy.
This contains BREAKING CHANGES as a result of the C&TA Sprint 7 Review, and STU2 Sequence ballot reconciliation.
This version is not yet reviewed 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

An example to illustrate sending an associated encounter with family member history

Table View

FamilyMemberHistory.id[0]	UKCore-Extension-AssociatedEncounter-Example
FamilyMemberHistory.text[0].status[0]	additional
FamilyMemberHistory.text[0].div[0]	<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate sending an associated encounter with family member history</div>
FamilyMemberHistory.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AssociatedEncounter
FamilyMemberHistory.extension[0].value[0].reference[0]	Encounter/UKCore-Encounter-InpatientEncounter-Example
FamilyMemberHistory.status[0]	partial
FamilyMemberHistory.patient[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example
FamilyMemberHistory.patient[0].display[0]	Richard Smith
FamilyMemberHistory.date[0]	2023-05-09
FamilyMemberHistory.relationship[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/v3-RoleCode
FamilyMemberHistory.relationship[0].coding[0].code[0]	FTH
FamilyMemberHistory.relationship[0].coding[0].display[0]	father
FamilyMemberHistory.sex[0].coding[0].system[0]	http://hl7.org/fhir/administrative-gender
FamilyMemberHistory.sex[0].coding[0].code[0]	male
FamilyMemberHistory.sex[0].coding[0].display[0]	Male
FamilyMemberHistory.born[0]	1949-12-13
FamilyMemberHistory.condition[0].code[0].coding[0].system[0]	http://snomed.info/sct
FamilyMemberHistory.condition[0].code[0].coding[0].code[0]	275121006
FamilyMemberHistory.condition[0].code[0].coding[0].display[0]	Family history: Angina
FamilyMemberHistory.condition[0].onset[0].value[0]	64
FamilyMemberHistory.condition[0].onset[0].unit[0]	year
FamilyMemberHistory.condition[0].onset[0].system[0]	http://unitsofmeasure.org
FamilyMemberHistory.condition[0].onset[0].code[0]	a

Tree View

FamilyMemberHistory

id : UKCore-Extension-AssociatedEncounter-Example

text

status : additional

extension

url : https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AssociatedEncounter

value

reference : Encounter/UKCore-Encounter-InpatientEncounter-Example

status : partial

patient

reference : Patient/UKCore-Patient-RichardSmith-Example

display : Richard Smith

date : 2023-05-09

relationship

coding

system : http://terminology.hl7.org/CodeSystem/v3-RoleCode

code : FTH

display : father

sex

coding

system : http://hl7.org/fhir/administrative-gender

code : male

display : Male

born : 1949-12-13

condition

code

coding

system : http://snomed.info/sct

code : 275121006

display : Family history: Angina

onset

value : 64

unit : year

system : http://unitsofmeasure.org

code : a

XML View

<FamilyMemberHistory xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-AssociatedEncounter-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  **************extension start**************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AssociatedEncounter">
        <valueReference>
            <reference value="Encounter/UKCore-Encounter-InpatientEncounter-Example" />
        </valueReference>
    </extension>
    <!--  **************extension end**************  -->
    <status value="partial" />
    <patient>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
        <display value="Richard Smith" />
    </patient>
    <date value="2023-05-09" />
    <relationship>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode" />
            <code value="FTH" />
            <display value="father" />
        </coding>
    </relationship>
    <sex>
        <coding>
            <system value="http://hl7.org/fhir/administrative-gender" />
            <code value="male" />
            <display value="Male" />
        </coding>
    </sex>
    <bornDate value="1949-12-13" />
    <condition>
        <code>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="275121006" />
                <display value="Family history: Angina" />
            </coding>
        </code>
        <onsetAge>
            <value value="64" />
            <unit value="year" />
            <system value="http://unitsofmeasure.org" />
            <code value="a" />
        </onsetAge>
    </condition>
</FamilyMemberHistory>

JSON View

{
    "resourceType": "FamilyMemberHistory",
    "id": "UKCore-Extension-AssociatedEncounter-Example",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AssociatedEncounter",
            "valueReference": {
                "reference": "Encounter/UKCore-Encounter-InpatientEncounter-Example"
            }
        }
    ],
    "status": "partial",
    "patient": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example",
        "display": "Richard Smith"
    },
    "date": "2023-05-09",
    "relationship": {
        "coding":  [
            {
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code": "FTH",
                "display": "father"
            }
        ]
    },
    "sex": {
        "coding":  [
            {
                "system": "http://hl7.org/fhir/administrative-gender",
                "code": "male",
                "display": "Male"
            }
        ]
    },
    "bornDate": "1949-12-13",
    "condition":  [
        {
            "code": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "275121006",
                        "display": "Family history: Angina"
                    }
                ]
            },
            "onsetAge": {
                "value": 64,
                "unit": "year",
                "system": "http://unitsofmeasure.org",
                "code": "a"
            }
        }
    ]
}