UK Core Implementation Guide Assets in Development

UK Core Implementation Guide Assets in Development

Examples

Table View

AuditEvent.id[0]UKCore-AuditEvent-Query-Example
AuditEvent.type[0].system[0]http://dicom.nema.org/resources/ontology/DCM
AuditEvent.type[0].code[0]110112
AuditEvent.type[0].display[0]Query
AuditEvent.subtype[0].system[0]http://hl7.org/fhir/restful-interaction
AuditEvent.subtype[0].code[0]search
AuditEvent.subtype[0].display[0]search
AuditEvent.recorded[0]2020-12-10T13:10:00+00:00
AuditEvent.agent[0].role[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/v3-RoleCode
AuditEvent.agent[0].role[0].coding[0].code[0]RESPRSN
AuditEvent.agent[0].role[0].coding[0].display[0]responsible party
AuditEvent.agent[0].who[0].reference[0]Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example
AuditEvent.agent[0].requestor[0]True
AuditEvent.agent[0].location[0].reference[0]Location/UKCore-Location-CardiologySJUH-Example
AuditEvent.source[0].observer[0].reference[0]Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example
AuditEvent.source[0].type[0].system[0]http://terminology.hl7.org/CodeSystem/security-source-type
AuditEvent.source[0].type[0].code[0]1
AuditEvent.source[0].type[0].display[0]User Device
AuditEvent.entity[0].what[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
AuditEvent.entity[0].type[0].system[0]http://hl7.org/fhir/resource-types
AuditEvent.entity[0].type[0].code[0]Patient
AuditEvent.entity[0].type[0].display[0]Patient

XML View

<AuditEvent xmlns="http://hl7.org/fhir">
    <id value="UKCore-AuditEvent-Query-Example" />
    <type>
        <system value="http://dicom.nema.org/resources/ontology/DCM" />
        <code value="110112" />
        <display value="Query" />
    </type>
    <subtype>
        <system value="http://hl7.org/fhir/restful-interaction" />
        <code value="search" />
        <display value="search" />
    </subtype>
    <recorded value="2020-12-10T13:10:00+00:00" />
    <agent>
        <role>
            <coding>
                <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode" />
                <code value="RESPRSN" />
                <display value="responsible party" />
            </coding>
        </role>
        <who>
            <reference value="Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example" />
        </who>
        <requestor value="true" />
        <location>
            <reference value="Location/UKCore-Location-CardiologySJUH-Example" />
        </location>
    </agent>
    <source>
        <observer>
            <reference value="Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example" />
        </observer>
        <type>
            <system value="http://terminology.hl7.org/CodeSystem/security-source-type" />
            <code value="1" />
            <display value="User Device" />
        </type>
    </source>
    <entity>
        <what>
            <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
        </what>
        <type>
            <system value="http://hl7.org/fhir/resource-types" />
            <code value="Patient" />
            <display value="Patient" />
        </type>
    </entity>
</AuditEvent>

JSON View

{
    "resourceType": "AuditEvent",
    "id": "UKCore-AuditEvent-Query-Example",
    "type": {
        "system": "http://dicom.nema.org/resources/ontology/DCM",
        "code": "110112",
        "display": "Query"
    },
    "subtype":  [
        {
            "system": "http://hl7.org/fhir/restful-interaction",
            "code": "search",
            "display": "search"
        }
    ],
    "recorded": "2020-12-10T13:10:00+00:00",
    "agent":  [
        {
            "role":  [
                {
                    "coding":  [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                            "code": "RESPRSN",
                            "display": "responsible party"
                        }
                    ]
                }
            ],
            "who": {
                "reference": "Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example"
            },
            "requestor": true,
            "location": {
                "reference": "Location/UKCore-Location-CardiologySJUH-Example"
            }
        }
    ],
    "source": {
        "observer": {
            "reference": "Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example"
        },
        "type":  [
            {
                "system": "http://terminology.hl7.org/CodeSystem/security-source-type",
                "code": "1",
                "display": "User Device"
            }
        ]
    },
    "entity":  [
        {
            "what": {
                "reference": "Patient/UKCore-Patient-RichardSmith-Example"
            },
            "type": {
                "system": "http://hl7.org/fhir/resource-types",
                "code": "Patient",
                "display": "Patient"
            }
        }
    ]
}

Example to illustrate a bundled allergy list.

Table View

Bundle.id[0]UKCore-Bundle-BundledAllergyList-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

XML View

<Bundle xmlns="http://hl7.org/fhir">
    <id value="UKCore-Bundle-BundledAllergyList-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-BundledAllergyList-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"
                    }
                ]
            }
        }
    ]
}

Example to illustrate a wellness plan for the management of Type 2 diabetes.

Table View

CarePlan.id[0]UKCore-CarePlan-WellnessPlan-Example
CarePlan.identifier[0].value[0]7d9955bc-afe0-11ea-b3de-0242ac130004
CarePlan.basedOn[0].display[0]Management of Type 2 Diabetes
CarePlan.partOf[0].display[0]Overall wellness plan
CarePlan.status[0]active
CarePlan.intent[0]plan
CarePlan.category[0].text[0]Weight management plan
CarePlan.description[0]Manage obesity and weight loss
CarePlan.subject[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
CarePlan.subject[0].type[0]Patient
CarePlan.subject[0].display[0]Richard SMITH
CarePlan.period[0].end[0]2020-01-01
CarePlan.created[0]2020-02-01
CarePlan.author[0].reference[0]Practitioner/UKCore-Practitioner-PaulRastall-Example
CarePlan.activity[0].outcomeCodeableConcept[0].coding[0].system[0]http://snomed.info/sct
CarePlan.activity[0].outcomeCodeableConcept[0].coding[0].code[0]161832001
CarePlan.activity[0].outcomeCodeableConcept[0].coding[0].display[0]Progressive weight loss
CarePlan.activity[0].detail[0].code[0].coding[0].system[0]http://snomed.info/sct
CarePlan.activity[0].detail[0].code[0].coding[0].code[0]27113001
CarePlan.activity[0].detail[0].code[0].coding[0].display[0]Body weight
CarePlan.activity[0].detail[0].status[0]completed
CarePlan.activity[0].detail[0].statusReason[0].text[0]Achieved weight loss to mitigate diabetes risk.
CarePlan.activity[0].detail[0].doNotPerform[0]False
CarePlan.activity[0].detail[0].scheduledTiming[0].repeat[0].frequency[0]1
CarePlan.activity[0].detail[0].scheduledTiming[0].repeat[0].period[0]1
CarePlan.activity[0].detail[0].scheduledTiming[0].repeat[0].periodUnit[0]d
CarePlan.activity[0].detail[0].location[0].display[0]Patient's home
CarePlan.activity[0].detail[0].performer[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example

XML View

<CarePlan xmlns="http://hl7.org/fhir">
    <id value="UKCore-CarePlan-WellnessPlan-Example" />
    <identifier>
        <value value="7d9955bc-afe0-11ea-b3de-0242ac130004" />
    </identifier>
    <basedOn>
        <display value="Management of Type 2 Diabetes" />
    </basedOn>
    <partOf>
        <display value="Overall wellness plan" />
    </partOf>
    <status value="active" />
    <intent value="plan" />
    <category>
        <text value="Weight management plan" />
    </category>
    <description value="Manage obesity and weight loss" />
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
        <type value="Patient" />
        <display value="Richard SMITH" />
    </subject>
    <period>
        <end value="2020-01-01" />
    </period>
    <created value="2020-02-01" />
    <author>
        <reference value="Practitioner/UKCore-Practitioner-PaulRastall-Example" />
    </author>
    <activity>
        <outcomeCodeableConcept>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="161832001" />
                <display value="Progressive weight loss" />
            </coding>
        </outcomeCodeableConcept>
        <detail>
            <code>
                <coding>
                    <system value="http://snomed.info/sct" />
                    <code value="27113001" />
                    <display value="Body weight" />
                </coding>
            </code>
            <status value="completed" />
            <statusReason>
                <text value="Achieved weight loss to mitigate diabetes risk." />
            </statusReason>
            <doNotPerform value="false" />
            <scheduledTiming>
                <repeat>
                    <frequency value="1" />
                    <period value="1" />
                    <periodUnit value="d" />
                </repeat>
            </scheduledTiming>
            <location>
                <display value="Patient&#39;s home" />
            </location>
            <performer>
                <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
            </performer>
        </detail>
    </activity>
</CarePlan>

JSON View

{
    "resourceType": "CarePlan",
    "id": "UKCore-CarePlan-WellnessPlan-Example",
    "identifier":  [
        {
            "value": "7d9955bc-afe0-11ea-b3de-0242ac130004"
        }
    ],
    "basedOn":  [
        {
            "display": "Management of Type 2 Diabetes"
        }
    ],
    "partOf":  [
        {
            "display": "Overall wellness plan"
        }
    ],
    "status": "active",
    "intent": "plan",
    "category":  [
        {
            "text": "Weight management plan"
        }
    ],
    "description": "Manage obesity and weight loss",
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example",
        "type": "Patient",
        "display": "Richard SMITH"
    },
    "period": {
        "end": "2020-01-01"
    },
    "created": "2020-02-01",
    "author": {
        "reference": "Practitioner/UKCore-Practitioner-PaulRastall-Example"
    },
    "activity":  [
        {
            "outcomeCodeableConcept":  [
                {
                    "coding":  [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "161832001",
                            "display": "Progressive weight loss"
                        }
                    ]
                }
            ],
            "detail": {
                "code": {
                    "coding":  [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "27113001",
                            "display": "Body weight"
                        }
                    ]
                },
                "status": "completed",
                "statusReason": {
                    "text": "Achieved weight loss to mitigate diabetes risk."
                },
                "doNotPerform": false,
                "scheduledTiming": {
                    "repeat": {
                        "frequency": 1,
                        "period": 1,
                        "periodUnit": "d"
                    }
                },
                "location": {
                    "display": "Patient's home"
                },
                "performer":  [
                    {
                        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
                    }
                ]
            }
        }
    ]
}

Example to illustrate a weight management care team.

Table View

CareTeam.id[0]UKCore-CareTeam-WeightManagementTeam-Example
CareTeam.identifier[0].system[0]https://tools.ietf.org/html/rfc4122
CareTeam.identifier[0].value[0]0e7cc7b2-94b7-42c2-875b-56c921e4bcc2
CareTeam.status[0]inactive
CareTeam.name[0]Weight management team
CareTeam.subject[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
CareTeam.participant[0].member[0].reference[0]Practitioner/UKCore-Practitioner-PaulRastall-Example
CareTeam.managingOrganization[0].reference[0]Organization/UKCore-Organisation-WhiteRoseMedicalCentre-Example

XML View

<CareTeam xmlns="http://hl7.org/fhir">
    <id value="UKCore-CareTeam-WeightManagementTeam-Example" />
    <identifier>
        <system value="https://tools.ietf.org/html/rfc4122" />
        <value value="0e7cc7b2-94b7-42c2-875b-56c921e4bcc2" />
    </identifier>
    <status value="inactive" />
    <name value="Weight management team" />
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <participant>
        <member>
            <reference value="Practitioner/UKCore-Practitioner-PaulRastall-Example" />
        </member>
    </participant>
    <managingOrganization>
        <reference value="Organization/UKCore-Organisation-WhiteRoseMedicalCentre-Example" />
    </managingOrganization>
</CareTeam>

JSON View

{
    "resourceType": "CareTeam",
    "id": "UKCore-CareTeam-WeightManagementTeam-Example",
    "identifier":  [
        {
            "system": "https://tools.ietf.org/html/rfc4122",
            "value": "0e7cc7b2-94b7-42c2-875b-56c921e4bcc2"
        }
    ],
    "status": "inactive",
    "name": "Weight management team",
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "participant":  [
        {
            "member": {
                "reference": "Practitioner/UKCore-Practitioner-PaulRastall-Example"
            }
        }
    ],
    "managingOrganization":  [
        {
            "reference": "Organization/UKCore-Organisation-WhiteRoseMedicalCentre-Example"
        }
    ]
}

Example to illustrate a communication to notify that a patient has had their first MMR Vaccination.

Table View

Communication.id[0]UKCore-Communication-FirstMMRVaccination-Example
Communication.text[0].status[0]generated
Communication.text[0].div[0]
First MMR vacinnation administered to Melanie.
Communication.status[0]completed
Communication.category[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings
Communication.category[0].coding[0].code[0]immunisations
Communication.category[0].coding[0].display[0]Immunisations
Communication.category[1].coding[0].system[0]http://terminology.hl7.org/CodeSystem/communication-category
Communication.category[1].coding[0].code[0]notification
Communication.category[1].coding[0].display[0]Notification
Communication.medium[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/v3-ParticipationMode
Communication.medium[0].coding[0].code[0]ELECTRONIC
Communication.medium[0].coding[0].display[0]electronic data
Communication.subject[0].reference[0]Patient/UKCore-Patient-BabyPatient-Example
Communication.subject[0].display[0]JONES, Melanie
Communication.sent[0]2022-12-11T13:00:00+00:00
Communication.received[0]2022-12-11T13:01:33+00:00
Communication.sender[0].reference[0]Practitioner/UKCore-Practitioner-PaulRastall-Example
Communication.sender[0].display[0]Dr Paul Rastall
Communication.payload[0].contentString[0]First MMR vacinnation administered to Melanie

XML View

<Communication xmlns="http://hl7.org/fhir">
    <id value="UKCore-Communication-FirstMMRVaccination-Example" />
    <text>
        <status value="generated" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <status value="completed" />
    <category>
        <coding>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings" />
            <code value="immunisations" />
            <display value="Immunisations" />
        </coding>
    </category>
    <category>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/communication-category" />
            <code value="notification" />
            <display value="Notification" />
        </coding>
    </category>
    <medium>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationMode" />
            <code value="ELECTRONIC" />
            <display value="electronic data" />
        </coding>
    </medium>
    <subject>
        <reference value="Patient/UKCore-Patient-BabyPatient-Example" />
        <display value="JONES, Melanie" />
    </subject>
    <!-- 	<encounter>
		<reference value="Encounter/UKCore-Encounter-InpatientEncounter-Example"/>
	</encounter> -->
    <sent value="2022-12-11T13:00:00+00:00" />
    <received value="2022-12-11T13:01:33+00:00" />
    <sender>
        <reference value="Practitioner/UKCore-Practitioner-PaulRastall-Example" />
        <display value="Dr Paul Rastall" />
    </sender>
    <payload>
        <contentString value="First MMR vacinnation administered to Melanie" />
    </payload>
</Communication>

JSON View

{
    "resourceType": "Communication",
    "id": "UKCore-Communication-FirstMMRVaccination-Example",
    "text": {
        "status": "generated",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "status": "completed",
    "category":  [
        {
            "coding":  [
                {
                    "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings",
                    "code": "immunisations",
                    "display": "Immunisations"
                }
            ]
        },
        {
            "coding":  [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/communication-category",
                    "code": "notification",
                    "display": "Notification"
                }
            ]
        }
    ],
    "medium":  [
        {
            "coding":  [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationMode",
                    "code": "ELECTRONIC",
                    "display": "electronic data"
                }
            ]
        }
    ],
    "subject": {
        "reference": "Patient/UKCore-Patient-BabyPatient-Example",
        "display": "JONES, Melanie"
    },
    "sent": "2022-12-11T13:00:00+00:00",
    "received": "2022-12-11T13:01:33+00:00",
    "sender": {
        "reference": "Practitioner/UKCore-Practitioner-PaulRastall-Example",
        "display": "Dr Paul Rastall"
    },
    "payload":  [
        {
            "contentString": "First MMR vacinnation administered to Melanie"
        }
    ]
}

Example to illustrate the use of a colostomy bag as a device in the provision of healthcare.

Table View

Device.id[0]UKCore-Device-ColostomyBag-Example
Device.identifier[0].system[0]https://www.leedsth.nhs.uk/identifier/devices
Device.identifier[0].value[0]DEV1999990567
Device.identifier[0].assigner[0].reference[0]Organization/UKCore-Organization-LeedsTeachingHospital-Example
Device.status[0]active
Device.type[0].coding[0].system[0]http://snomed.info/sct
Device.type[0].coding[0].code[0]7081011000001108
Device.type[0].coding[0].display[0]Ostopore KAV colostomy bag made to order 744045 45mm Opaque (DBT Medical Ltd) 30 device
Device.owner[0].reference[0]Organization/UKCore-Organization-LeedsTeachingHospital-Example
Device.location[0].reference[0]Location/UKCore-Location-CardiologySJUH-Example
Device.note[0].time[0]2021-01-10T16:10:00+00:00
Device.note[0].text[0]Pack of 50 currently stored in SJUH Cardiology.

XML View

<Device xmlns="http://hl7.org/fhir">
    <id value="UKCore-Device-ColostomyBag-Example" />
    <identifier>
        <system value="https://www.leedsth.nhs.uk/identifier/devices" />
        <value value="DEV1999990567" />
        <assigner>
            <reference value="Organization/UKCore-Organization-LeedsTeachingHospital-Example" />
        </assigner>
    </identifier>
    <status value="active" />
    <type>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="7081011000001108" />
            <display value="Ostopore KAV colostomy bag made to order 744045 45mm Opaque (DBT Medical Ltd) 30 device" />
        </coding>
    </type>
    <owner>
        <reference value="Organization/UKCore-Organization-LeedsTeachingHospital-Example" />
    </owner>
    <location>
        <reference value="Location/UKCore-Location-CardiologySJUH-Example" />
    </location>
    <note>
        <time value="2021-01-10T16:10:00+00:00" />
        <text value="Pack of 50 currently stored in SJUH Cardiology." />
    </note>
</Device>

JSON View

{
    "resourceType": "Device",
    "id": "UKCore-Device-ColostomyBag-Example",
    "identifier":  [
        {
            "system": "https://www.leedsth.nhs.uk/identifier/devices",
            "value": "DEV1999990567",
            "assigner": {
                "reference": "Organization/UKCore-Organization-LeedsTeachingHospital-Example"
            }
        }
    ],
    "status": "active",
    "type": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "7081011000001108",
                "display": "Ostopore KAV colostomy bag made to order 744045 45mm Opaque (DBT Medical Ltd) 30 device"
            }
        ]
    },
    "owner": {
        "reference": "Organization/UKCore-Organization-LeedsTeachingHospital-Example"
    },
    "location": {
        "reference": "Location/UKCore-Location-CardiologySJUH-Example"
    },
    "note":  [
        {
            "time": "2021-01-10T16:10:00+00:00",
            "text": "Pack of 50 currently stored in SJUH Cardiology."
        }
    ]
}

Example to illustrate a document reference for a care plan report PDF.

Table View

DocumentReference.id[0]UKCore-DocumentReference-CarePlanReportPDF-Example
DocumentReference.status[0]current
DocumentReference.type[0].coding[0].system[0]http://snomed.info/sct
DocumentReference.type[0].coding[0].code[0]734163000
DocumentReference.type[0].coding[0].display[0]Care plan
DocumentReference.subject[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
DocumentReference.date[0]2016-03-08T15:26:00+01:00
DocumentReference.author[0].reference[0]Practitioner/UKCore-Practitioner-SandraGose-Example
DocumentReference.custodian[0].reference[0]Organization/UKCore-Organisation-LeedsTeachingHospital-Example
DocumentReference.content[0].attachment[0].contentType[0]application/pdf
DocumentReference.content[0].attachment[0].url[0]https://health.trust.uk/CarePlanReport_44301kfgd.pdf
DocumentReference.content[0].attachment[0].title[0]Care Plan Report
DocumentReference.content[0].attachment[0].creation[0]2016-03-08T15:26:00+01:00

XML View

<DocumentReference xmlns="http://hl7.org/fhir">
    <id value="UKCore-DocumentReference-CarePlanReportPDF-Example" />
    <status value="current" />
    <type>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="734163000" />
            <display value="Care plan" />
        </coding>
    </type>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <date value="2016-03-08T15:26:00+01:00" />
    <author>
        <reference value="Practitioner/UKCore-Practitioner-SandraGose-Example" />
    </author>
    <custodian>
        <reference value="Organization/UKCore-Organisation-LeedsTeachingHospital-Example" />
    </custodian>
    <content>
        <attachment>
            <contentType value="application/pdf" />
            <url value="https://health.trust.uk/CarePlanReport_44301kfgd.pdf" />
            <title value="Care Plan Report" />
            <creation value="2016-03-08T15:26:00+01:00" />
        </attachment>
    </content>
</DocumentReference>

JSON View

{
    "resourceType": "DocumentReference",
    "id": "UKCore-DocumentReference-CarePlanReportPDF-Example",
    "status": "current",
    "type": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "734163000",
                "display": "Care plan"
            }
        ]
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "date": "2016-03-08T15:26:00+01:00",
    "author":  [
        {
            "reference": "Practitioner/UKCore-Practitioner-SandraGose-Example"
        }
    ],
    "custodian": {
        "reference": "Organization/UKCore-Organisation-LeedsTeachingHospital-Example"
    },
    "content":  [
        {
            "attachment": {
                "contentType": "application/pdf",
                "url": "https://health.trust.uk/CarePlanReport_44301kfgd.pdf",
                "title": "Care Plan Report",
                "creation": "2016-03-08T15:26:00+01:00"
            }
        }
    ]
}

Example to illustrate an observation of the awareness of diagnosis.

Table View

Observation.id[0]UKCore-Observation-AwarenessOfDiagnosis-Example
Observation.status[0]final
Observation.code[0].coding[0].system[0]http://snomed.info/sct
Observation.code[0].coding[0].code[0]162564003
Observation.code[0].coding[0].display[0]Awareness of diagnosis
Observation.subject[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
Observation.effectiveInstant[0]2019-12-10T13:00:00+00:00

XML View

<Observation xmlns="http://hl7.org/fhir">
    <id value="UKCore-Observation-AwarenessOfDiagnosis-Example" />
    <status value="final" />
    <code>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="162564003" />
            <display value="Awareness of diagnosis" />
        </coding>
    </code>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <effectiveInstant value="2019-12-10T13:00:00+00:00" />
</Observation>

JSON View

{
    "resourceType": "Observation",
    "id": "UKCore-Observation-AwarenessOfDiagnosis-Example",
    "status": "final",
    "code": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "162564003",
                "display": "Awareness of diagnosis"
            }
        ]
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "effectiveInstant": "2019-12-10T13:00:00+00:00"
}

Example to illustrate an observation of the total white cell count.

Table View

Observation.id[0]UKCore-Observation-WhiteCellCount-Example
Observation.identifier[0].system[0]https://tools.ietf.org/html/rfc4122
Observation.identifier[0].value[0]2af46949-4938-4c57-bad4-c4363e1965d5
Observation.status[0]final
Observation.category[0].coding[0].system[0]http://snomed.info/sct
Observation.category[0].coding[0].code[0]394595002
Observation.category[0].coding[0].display[0]Pathology
Observation.code[0].coding[0].system[0]http://snomed.info/sct
Observation.code[0].coding[0].code[0]1022541000000102
Observation.code[0].coding[0].display[0]Total white cell count
Observation.performer[0].reference[0]Oranization/UKCore-Organization-LeedsTeachingHospital-Example
Observation.valueQuantity[0].value[0]11.2
Observation.valueQuantity[0].unit[0]10*9/L
Observation.specimen[0].reference[0]Specimen/UKCore-Specimen-BloodSpecimen-Example
Observation.referenceRange[0].low[0].value[0]4.0
Observation.referenceRange[0].high[0].value[0]17.0

XML View

<Observation xmlns="http://hl7.org/fhir">
    <id value="UKCore-Observation-WhiteCellCount-Example" />
    <identifier>
        <system value="https://tools.ietf.org/html/rfc4122" />
        <value value="2af46949-4938-4c57-bad4-c4363e1965d5" />
    </identifier>
    <status value="final" />
    <category>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="394595002" />
            <display value="Pathology" />
        </coding>
    </category>
    <code>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="1022541000000102" />
            <display value="Total white cell count" />
        </coding>
    </code>
    <performer>
        <reference value="Oranization/UKCore-Organization-LeedsTeachingHospital-Example" />
    </performer>
    <valueQuantity>
        <value value="11.2" />
        <unit value="10*9/L" />
    </valueQuantity>
    <specimen>
        <reference value="Specimen/UKCore-Specimen-BloodSpecimen-Example" />
    </specimen>
    <referenceRange>
        <low>
            <value value="4.0" />
        </low>
        <high>
            <value value="17.0" />
        </high>
    </referenceRange>
</Observation>

JSON View

{
    "resourceType": "Observation",
    "id": "UKCore-Observation-WhiteCellCount-Example",
    "identifier":  [
        {
            "system": "https://tools.ietf.org/html/rfc4122",
            "value": "2af46949-4938-4c57-bad4-c4363e1965d5"
        }
    ],
    "status": "final",
    "category":  [
        {
            "coding":  [
                {
                    "system": "http://snomed.info/sct",
                    "code": "394595002",
                    "display": "Pathology"
                }
            ]
        }
    ],
    "code": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "1022541000000102",
                "display": "Total white cell count"
            }
        ]
    },
    "performer":  [
        {
            "reference": "Oranization/UKCore-Organization-LeedsTeachingHospital-Example"
        }
    ],
    "valueQuantity": {
        "value": 11.2,
        "unit": "10*9/L"
    },
    "specimen": {
        "reference": "Specimen/UKCore-Specimen-BloodSpecimen-Example"
    },
    "referenceRange":  [
        {
            "low": {
                "value": 4
            },
            "high": {
                "value": 17
            }
        }
    ]
}

Table View

Provenance.id[0]UKCore-Provenance-RARecordConsent-Example
Provenance.target[0].reference[0]Consent/UKCore-Consent-ForInformationAccess-Example
Provenance.recorded[0]2022-03-01T10:05:33+00:00
Provenance.agent[0].role[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-SDSJobRoleName
Provenance.agent[0].role[0].coding[0].code[0]R0260
Provenance.agent[0].role[0].coding[0].display[0]General Medical Practitioner
Provenance.agent[0].who[0].reference[0]Practitioner/UKCore-Practitioner-PaulRastall-Example
Provenance.agent[0].who[0].display[0]Dr Paul Rastall
Provenance.agent[0].onBehalfOf[0].reference[0]Organization/https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization
Provenance.agent[0].onBehalfOf[0].display[0]White Rose Medical Centre

XML View

<Provenance xmlns="http://hl7.org/fhir">
    <id value="UKCore-Provenance-RARecordConsent-Example" />
    <target>
        <reference value="Consent/UKCore-Consent-ForInformationAccess-Example" />
    </target>
    <recorded value="2022-03-01T10:05:33+00:00" />
    <agent>
        <!-- The actor who has some responsibility for the activity taking place -->
        <role>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-SDSJobRoleName" />
                <code value="R0260" />
                <display value="General Medical Practitioner" />
            </coding>
        </role>
        <who>
            <reference value="Practitioner/UKCore-Practitioner-PaulRastall-Example" />
            <display value="Dr Paul Rastall" />
        </who>
        <onBehalfOf>
            <reference value="Organization/https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            <display value="White Rose Medical Centre" />
        </onBehalfOf>
    </agent>
</Provenance>

JSON View

{
    "resourceType": "Provenance",
    "id": "UKCore-Provenance-RARecordConsent-Example",
    "target":  [
        {
            "reference": "Consent/UKCore-Consent-ForInformationAccess-Example"
        }
    ],
    "recorded": "2022-03-01T10:05:33+00:00",
    "agent":  [
        {
            "role":  [
                {
                    "coding":  [
                        {
                            "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-SDSJobRoleName",
                            "code": "R0260",
                            "display": "General Medical Practitioner"
                        }
                    ]
                }
            ],
            "who": {
                "reference": "Practitioner/UKCore-Practitioner-PaulRastall-Example",
                "display": "Dr Paul Rastall"
            },
            "onBehalfOf": {
                "reference": "Organization/https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization",
                "display": "White Rose Medical Centre"
            }
        }
    ]
}

Example to illustrate how oxygen saturation is recorded as a vital signs observation.

Table View

Observation.id[0]UKCore-Observation-AwarenessOfDiagnosis-Example
Observation.status[0]final
Observation.code[0].coding[0].system[0]http://snomed.info/sct
Observation.code[0].coding[0].code[0]162564003
Observation.code[0].coding[0].display[0]Awareness of diagnosis
Observation.subject[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
Observation.effectiveInstant[0]2019-12-10T13:00:00+00:00

XML View

<Observation xmlns="http://hl7.org/fhir">
    <id value="UKCore-Observation-AwarenessOfDiagnosis-Example" />
    <status value="final" />
    <code>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="162564003" />
            <display value="Awareness of diagnosis" />
        </coding>
    </code>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <effectiveInstant value="2019-12-10T13:00:00+00:00" />
</Observation>

JSON View

{
    "resourceType": "Observation",
    "id": "UKCore-Observation-AwarenessOfDiagnosis-Example",
    "status": "final",
    "code": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "162564003",
                "display": "Awareness of diagnosis"
            }
        ]
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "effectiveInstant": "2019-12-10T13:00:00+00:00"
}
back to top