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 medication request for eye drops

Table View

MedicationRequest.id[0]	UKCore-MedicationRequest-EyeDrops-Example
MedicationRequest.text[0].status[0]	additional
MedicationRequest.text[0].div[0]	<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate a medication request for eye drops</div>
MedicationRequest.status[0]	completed
MedicationRequest.intent[0]	order
MedicationRequest.category[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/medicationrequest-category
MedicationRequest.category[0].coding[0].code[0]	outpatient
MedicationRequest.category[0].coding[0].display[0]	Outpatient
MedicationRequest.medication[0].reference[0]	Medication/UKCore-Medication-TimoptolEyeDrops-Example
MedicationRequest.subject[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example
MedicationRequest.authoredOn[0]	2022-09-10T15:00:00.000Z
MedicationRequest.requester[0].reference[0]	Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example
MedicationRequest.courseOfTherapyType[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/medicationrequest-course-of-therapy
MedicationRequest.courseOfTherapyType[0].coding[0].code[0]	acute
MedicationRequest.courseOfTherapyType[0].coding[0].display[0]	Short course (acute) therapy
MedicationRequest.dosageInstruction[0].text[0]	1 drop in left eye, every 12 hours, until finished.
MedicationRequest.dosageInstruction[0].timing[0].repeat[0].frequency[0]	1
MedicationRequest.dosageInstruction[0].timing[0].repeat[0].period[0]	12
MedicationRequest.dosageInstruction[0].timing[0].repeat[0].periodUnit[0]	h
MedicationRequest.dosageInstruction[0].site[0].coding[0].system[0]	http://snomed.info/sct
MedicationRequest.dosageInstruction[0].site[0].coding[0].code[0]	8966001
MedicationRequest.dosageInstruction[0].site[0].coding[0].display[0]	Left eye structure
MedicationRequest.dosageInstruction[0].route[0].coding[0].system[0]	http://snomed.info/sct
MedicationRequest.dosageInstruction[0].route[0].coding[0].code[0]	58831000052108
MedicationRequest.dosageInstruction[0].route[0].coding[0].display[0]	Subretinal route
MedicationRequest.dosageInstruction[0].method[0].coding[0].system[0]	http://snomed.info/sct
MedicationRequest.dosageInstruction[0].method[0].coding[0].code[0]	421984009
MedicationRequest.dosageInstruction[0].method[0].coding[0].display[0]	Until finished
MedicationRequest.dosageInstruction[0].doseAndRate[0].type[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/dose-rate-type
MedicationRequest.dosageInstruction[0].doseAndRate[0].type[0].coding[0].code[0]	ordered
MedicationRequest.dosageInstruction[0].doseAndRate[0].type[0].coding[0].display[0]	Ordered
MedicationRequest.dosageInstruction[0].doseAndRate[0].dose[0].value[0]	1
MedicationRequest.dosageInstruction[0].doseAndRate[0].dose[0].unit[0]	drop
MedicationRequest.dosageInstruction[0].doseAndRate[0].dose[0].system[0]	http://unitsofmeasure.org
MedicationRequest.dosageInstruction[0].doseAndRate[0].dose[0].code[0]	[drp]
MedicationRequest.substitution[0].allowed[0]	True

Tree View

MedicationRequest

text

status : additional

id : UKCore-MedicationRequest-EyeDrops-Example

status : completed

intent : order

category

coding

system : http://terminology.hl7.org/CodeSystem/medicationrequest-category

code : outpatient

display : Outpatient

medication

reference : Medication/UKCore-Medication-TimoptolEyeDrops-Example

subject

reference : Patient/UKCore-Patient-RichardSmith-Example

authoredOn : 2022-09-10T15:00:00.000Z

requester

reference : Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example

courseOfTherapyType

coding

system : http://terminology.hl7.org/CodeSystem/medicationrequest-course-of-therapy

code : acute

display : Short course (acute) therapy

dosageInstruction

text : 1 drop in left eye, every 12 hours, until finished.

timing

repeat

frequency : 1

period : 12

periodUnit : h

site

coding

system : http://snomed.info/sct

code : 8966001

display : Left eye structure

route

coding

system : http://snomed.info/sct

code : 58831000052108

display : Subretinal route

method

coding

system : http://snomed.info/sct

code : 421984009

display : Until finished

doseAndRate

type

coding

system : http://terminology.hl7.org/CodeSystem/dose-rate-type

code : ordered

display : Ordered

dose

value : 1

unit : drop

system : http://unitsofmeasure.org

code : [drp]

substitution

allowed : True

XML View

<MedicationRequest xmlns="http://hl7.org/fhir">
    <id value="UKCore-MedicationRequest-EyeDrops-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <status value="completed" />
    <intent value="order" />
    <category>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/medicationrequest-category" />
            <code value="outpatient" />
            <display value="Outpatient" />
        </coding>
    </category>
    <medicationReference>
        <reference value="Medication/UKCore-Medication-TimoptolEyeDrops-Example" />
    </medicationReference>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <authoredOn value="2022-09-10T15:00:00.000Z" />
    <requester>
        <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" />
    </requester>
    <courseOfTherapyType>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/medicationrequest-course-of-therapy" />
            <code value="acute" />
            <display value="Short course (acute) therapy" />
        </coding>
    </courseOfTherapyType>
    <dosageInstruction>
        <text value="1 drop in left eye, every 12 hours, until finished." />
        <timing>
            <repeat>
                <frequency value="1" />
                <period value="12" />
                <periodUnit value="h" />
            </repeat>
        </timing>
        <site>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="8966001" />
                <display value="Left eye structure" />
            </coding>
        </site>
        <route>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="58831000052108" />
                <display value="Subretinal route" />
            </coding>
        </route>
        <method>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="421984009" />
                <display value="Until finished" />
            </coding>
        </method>
        <doseAndRate>
            <type>
                <coding>
                    <system value="http://terminology.hl7.org/CodeSystem/dose-rate-type" />
                    <code value="ordered" />
                    <display value="Ordered" />
                </coding>
            </type>
            <doseQuantity>
                <value value="1" />
                <unit value="drop" />
                <system value="http://unitsofmeasure.org" />
                <code value="[drp]" />
            </doseQuantity>
        </doseAndRate>
    </dosageInstruction>
    <substitution>
        <allowedBoolean value="true" />
    </substitution>
</MedicationRequest>

JSON View

{
    "resourceType": "MedicationRequest",
    "id": "UKCore-MedicationRequest-EyeDrops-Example",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "status": "completed",
    "intent": "order",
    "category":  [
        {
            "coding":  [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/medicationrequest-category",
                    "code": "outpatient",
                    "display": "Outpatient"
                }
            ]
        }
    ],
    "medicationReference": {
        "reference": "Medication/UKCore-Medication-TimoptolEyeDrops-Example"
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "authoredOn": "2022-09-10T15:00:00.000Z",
    "requester": {
        "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example"
    },
    "courseOfTherapyType": {
        "coding":  [
            {
                "system": "http://terminology.hl7.org/CodeSystem/medicationrequest-course-of-therapy",
                "code": "acute",
                "display": "Short course (acute) therapy"
            }
        ]
    },
    "dosageInstruction":  [
        {
            "text": "1 drop in left eye, every 12 hours, until finished.",
            "timing": {
                "repeat": {
                    "frequency": 1,
                    "period": 12,
                    "periodUnit": "h"
                }
            },
            "site": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "8966001",
                        "display": "Left eye structure"
                    }
                ]
            },
            "route": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "58831000052108",
                        "display": "Subretinal route"
                    }
                ]
            },
            "method": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "421984009",
                        "display": "Until finished"
                    }
                ]
            },
            "doseAndRate":  [
                {
                    "type": {
                        "coding":  [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/dose-rate-type",
                                "code": "ordered",
                                "display": "Ordered"
                            }
                        ]
                    },
                    "doseQuantity": {
                        "value": 1,
                        "unit": "drop",
                        "system": "http://unitsofmeasure.org",
                        "code": "[drp]"
                    }
                }
            ]
        }
    ],
    "substitution": {
        "allowedBoolean": true
    }
}