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 an allergy to Amoxicillin

Table View

AllergyIntolerance.id[0]	UKCore-AllergyIntolerance-Amoxicillin-Example
AllergyIntolerance.text[0].status[0]	additional
AllergyIntolerance.text[0].div[0]	<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate an allergy to Amoxicillin</div>
AllergyIntolerance.clinicalStatus[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
AllergyIntolerance.clinicalStatus[0].coding[0].code[0]	active
AllergyIntolerance.clinicalStatus[0].coding[0].display[0]	Active
AllergyIntolerance.verificationStatus[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/allergyintolerance-verification
AllergyIntolerance.verificationStatus[0].coding[0].code[0]	confirmed
AllergyIntolerance.verificationStatus[0].coding[0].display[0]	Confirmed
AllergyIntolerance.code[0].coding[0].system[0]	http://snomed.info/sct
AllergyIntolerance.code[0].coding[0].code[0]	372687004
AllergyIntolerance.code[0].coding[0].display[0]	Amoxicillin
AllergyIntolerance.patient[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example
AllergyIntolerance.encounter[0].reference[0]	Encounter/UKCore-Encounter-InpatientEncounter-Example
AllergyIntolerance.recordedDate[0]	2019-12-10T13:00:00+00:00
AllergyIntolerance.recorder[0].reference[0]	Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example
AllergyIntolerance.asserter[0].reference[0]	Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example
AllergyIntolerance.reaction[0].manifestation[0].coding[0].system[0]	http://snomed.info/sct
AllergyIntolerance.reaction[0].manifestation[0].coding[0].code[0]	247472004
AllergyIntolerance.reaction[0].manifestation[0].coding[0].display[0]	Urticarial rash
AllergyIntolerance.reaction[0].severity[0]	mild

Tree View

AllergyIntolerance

id : UKCore-AllergyIntolerance-Amoxicillin-Example

text

status : additional

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

<AllergyIntolerance xmlns="http://hl7.org/fhir">
    <id value="UKCore-AllergyIntolerance-Amoxicillin-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <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>

JSON View

{
    "resourceType": "AllergyIntolerance",
    "id": "UKCore-AllergyIntolerance-Amoxicillin-Example",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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"
        }
    ]
}