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 a bundled allergy list

Table View

Bundle.id[0]	UKCore-Bundle-AllergyList-Example
Bundle.type[0]	collection
Bundle.entry[0].fullUrl[0]	urn:uuid:d043d2b6-5782-4536-88b6-e537973a09fb
Bundle.entry[0].resource[0].id[0]	UKCore-Allergy-List-Example
Bundle.entry[0].resource[0].status[0]	current
Bundle.entry[0].resource[0].mode[0]	snapshot
Bundle.entry[0].resource[0].code[0].coding[0].system[0]	http://snomed.info/sct
Bundle.entry[0].resource[0].code[0].coding[0].code[0]	886921000000105
Bundle.entry[0].resource[0].code[0].coding[0].display[0]	Allergies and adverse reactions
Bundle.entry[0].resource[0].subject[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example
Bundle.entry[0].resource[0].date[0]	2019-12-10T13:00:00+00:00
Bundle.entry[0].resource[0].entry[0].item[0].reference[0]	urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4
Bundle.entry[1].fullUrl[0]	urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4
Bundle.entry[1].resource[0].id[0]	efae5859-28df-4e7d-be91-6df56d8215e4
Bundle.entry[1].resource[0].clinicalStatus[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
Bundle.entry[1].resource[0].clinicalStatus[0].coding[0].code[0]	active
Bundle.entry[1].resource[0].clinicalStatus[0].coding[0].display[0]	Active
Bundle.entry[1].resource[0].verificationStatus[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/allergyintolerance-verification
Bundle.entry[1].resource[0].verificationStatus[0].coding[0].code[0]	confirmed
Bundle.entry[1].resource[0].verificationStatus[0].coding[0].display[0]	Confirmed
Bundle.entry[1].resource[0].code[0].coding[0].system[0]	http://snomed.info/sct
Bundle.entry[1].resource[0].code[0].coding[0].code[0]	372687004
Bundle.entry[1].resource[0].code[0].coding[0].display[0]	Amoxicillin
Bundle.entry[1].resource[0].patient[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example
Bundle.entry[1].resource[0].encounter[0].reference[0]	Encounter/UKCore-Encounter-InpatientEncounter-Example
Bundle.entry[1].resource[0].recordedDate[0]	2019-12-10T13:00:00+00:00
Bundle.entry[1].resource[0].recorder[0].reference[0]	Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example
Bundle.entry[1].resource[0].asserter[0].reference[0]	Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example
Bundle.entry[1].resource[0].reaction[0].manifestation[0].coding[0].system[0]	http://snomed.info/sct
Bundle.entry[1].resource[0].reaction[0].manifestation[0].coding[0].code[0]	247472004
Bundle.entry[1].resource[0].reaction[0].manifestation[0].coding[0].display[0]	Urticarial rash
Bundle.entry[1].resource[0].reaction[0].severity[0]	mild

Tree View

Bundle

id : UKCore-Bundle-AllergyList-Example

type : collection

entry

fullUrl : urn:uuid:d043d2b6-5782-4536-88b6-e537973a09fb

resource

id : UKCore-Allergy-List-Example

status : current

mode : snapshot

code

coding

system : http://snomed.info/sct

code : 886921000000105

display : Allergies and adverse reactions

subject

reference : Patient/UKCore-Patient-RichardSmith-Example

date : 2019-12-10T13:00:00+00:00

entry

item

reference : urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4

entry

fullUrl : urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4

resource

id : efae5859-28df-4e7d-be91-6df56d8215e4

clinicalStatus

coding

system : http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical

code : active

display : Active

verificationStatus

coding

system : http://terminology.hl7.org/CodeSystem/allergyintolerance-verification

code : confirmed

display : Confirmed

code

coding

system : http://snomed.info/sct

code : 372687004

display : Amoxicillin

patient

reference : Patient/UKCore-Patient-RichardSmith-Example

encounter

reference : Encounter/UKCore-Encounter-InpatientEncounter-Example

recordedDate : 2019-12-10T13:00:00+00:00

recorder

reference : Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example

asserter

reference : Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example

reaction

manifestation

coding

system : http://snomed.info/sct

code : 247472004

display : Urticarial rash

severity : mild

XML View

<Bundle xmlns="http://hl7.org/fhir">
    <id value="UKCore-Bundle-AllergyList-Example" />
    <type value="collection" />
    <entry>
        <fullUrl value="urn:uuid:d043d2b6-5782-4536-88b6-e537973a09fb" />
        <resource>
            <List>
                <id value="UKCore-Allergy-List-Example" />
                <status value="current" />
                <mode value="snapshot" />
                <code>
                    <coding>
                        <system value="http://snomed.info/sct" />
                        <code value="886921000000105" />
                        <display value="Allergies and adverse reactions" />
                    </coding>
                </code>
                <subject>
                    <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
                </subject>
                <date value="2019-12-10T13:00:00+00:00" />
                <entry>
                    <item>
                        <reference value="urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4" />
                    </item>
                </entry>
            </List>
        </resource>
    </entry>
    <entry>
        <fullUrl value="urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4" />
        <resource>
            <AllergyIntolerance>
                <id value="efae5859-28df-4e7d-be91-6df56d8215e4" />
                <clinicalStatus>
                    <coding>
                        <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical" />
                        <code value="active" />
                        <display value="Active" />
                    </coding>
                </clinicalStatus>
                <verificationStatus>
                    <coding>
                        <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-verification" />
                        <code value="confirmed" />
                        <display value="Confirmed" />
                    </coding>
                </verificationStatus>
                <code>
                    <coding>
                        <system value="http://snomed.info/sct" />
                        <code value="372687004" />
                        <display value="Amoxicillin" />
                    </coding>
                </code>
                <patient>
                    <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
                </patient>
                <encounter>
                    <reference value="Encounter/UKCore-Encounter-InpatientEncounter-Example" />
                </encounter>
                <recordedDate value="2019-12-10T13:00:00+00:00" />
                <recorder>
                    <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" />
                </recorder>
                <asserter>
                    <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" />
                </asserter>
                <reaction>
                    <manifestation>
                        <coding>
                            <system value="http://snomed.info/sct" />
                            <code value="247472004" />
                            <display value="Urticarial rash" />
                        </coding>
                    </manifestation>
                    <severity value="mild" />
                </reaction>
            </AllergyIntolerance>
        </resource>
    </entry>
</Bundle>

JSON View

{
    "resourceType": "Bundle",
    "id": "UKCore-Bundle-AllergyList-Example",
    "type": "collection",
    "entry":  [
        {
            "fullUrl": "urn:uuid:d043d2b6-5782-4536-88b6-e537973a09fb",
            "resource": {
                "resourceType": "List",
                "id": "UKCore-Allergy-List-Example",
                "status": "current",
                "mode": "snapshot",
                "code": {
                    "coding":  [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "886921000000105",
                            "display": "Allergies and adverse reactions"
                        }
                    ]
                },
                "subject": {
                    "reference": "Patient/UKCore-Patient-RichardSmith-Example"
                },
                "date": "2019-12-10T13:00:00+00:00",
                "entry":  [
                    {
                        "item": {
                            "reference": "urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4"
                        }
                    }
                ]
            }
        },
        {
            "fullUrl": "urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4",
            "resource": {
                "resourceType": "AllergyIntolerance",
                "id": "efae5859-28df-4e7d-be91-6df56d8215e4",
                "clinicalStatus": {
                    "coding":  [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                            "code": "active",
                            "display": "Active"
                        }
                    ]
                },
                "verificationStatus": {
                    "coding":  [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
                            "code": "confirmed",
                            "display": "Confirmed"
                        }
                    ]
                },
                "code": {
                    "coding":  [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "372687004",
                            "display": "Amoxicillin"
                        }
                    ]
                },
                "patient": {
                    "reference": "Patient/UKCore-Patient-RichardSmith-Example"
                },
                "encounter": {
                    "reference": "Encounter/UKCore-Encounter-InpatientEncounter-Example"
                },
                "recordedDate": "2019-12-10T13:00:00+00:00",
                "recorder": {
                    "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example"
                },
                "asserter": {
                    "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example"
                },
                "reaction":  [
                    {
                        "manifestation":  [
                            {
                                "coding":  [
                                    {
                                        "system": "http://snomed.info/sct",
                                        "code": "247472004",
                                        "display": "Urticarial rash"
                                    }
                                ]
                            }
                        ],
                        "severity": "mild"
                    }
                ]
            }
        }
    ]
}