UK Core Implementation Guide STU3 Sequence

Please note:

This version of the UK Core is for C&TA Sprint 7 Review.
This version is not suitable 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

Examples

Examples Usage

Whilst every effort has been made to ensure that the examples are correct and useful, they are not a normative part of the specification.

An example to illustrate sending a reference to an additional contact with a service request

Table View

ServiceRequest.id[0]	UKCore-Extension-AdditionalContact-Example
ServiceRequest.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact
ServiceRequest.extension[0].value[0].reference[0]	Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example
ServiceRequest.status[0]	active
ServiceRequest.intent[0]	order
ServiceRequest.subject[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example
ServiceRequest.requester[0].reference[0]	Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example

XML View

<ServiceRequest xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-AdditionalContact-Example" />
    <!--  ***************extension start***************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact">
        <valueReference>
            <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" />
        </valueReference>
    </extension>
    <!--  **************extension end ******************  -->
    <status value="active" />
    <intent value="order" />
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <requester>
        <reference value="Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example" />
    </requester>
</ServiceRequest>

JSON View

{
    "resourceType": "ServiceRequest",
    "id": "UKCore-Extension-AdditionalContact-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact",
            "valueReference": {
                "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example"
            }
        }
    ],
    "status": "active",
    "intent": "order",
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "requester": {
        "reference": "Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example"
    }
}

An example to illustrate the use of an address key used with the address datatype

Table View

Patient.id[0]	UKCore-Extension-AddressKey-Example
Patient.address[0].extension[0].extension[0].url[0]	type
Patient.address[0].extension[0].extension[0].value[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType
Patient.address[0].extension[0].extension[0].value[0].code[0]	PAF
Patient.address[0].extension[0].extension[0].value[0].display[0]	Postcode Address File
Patient.address[0].extension[0].extension[1].url[0]	value
Patient.address[0].extension[0].extension[1].value[0]	LS10ABC
Patient.address[0].extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey
Patient.address[0].line[0]	4 Sandmoor Drive
Patient.address[0].city[0]	LEEDS
Patient.address[0].postalCode[0]	LS17 7DF

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-AddressKey-Example" />
    <address>
        <!--  **************extension start**************  -->
        <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey">
            <extension url="type">
                <valueCoding>
                    <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType" />
                    <code value="PAF" />
                    <display value="Postcode Address File" />
                </valueCoding>
            </extension>
            <extension url="value">
                <valueString value="LS10ABC" />
            </extension>
        </extension>
        <line value="4 Sandmoor Drive" />
        <city value="LEEDS" />
        <postalCode value="LS17 7DF" />
        <!--  *************extension end ***************** -->
    </address>
</Patient>

JSON View

{
    "resourceType": "Patient",
    "id": "UKCore-Extension-AddressKey-Example",
    "address":  [
        {
            "extension":  [
                {
                    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey",
                    "extension":  [
                        {
                            "url": "type",
                            "valueCoding": {
                                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType",
                                "code": "PAF",
                                "display": "Postcode Address File"
                            }
                        },
                        {
                            "url": "value",
                            "valueString": "LS10ABC"
                        }
                    ]
                }
            ],
            "line":  [
                "4 Sandmoor Drive"
            ],
            "city": "LEEDS",
            "postalCode": "LS17 7DF"
        }
    ]
}

An example to illustrate the extension for an encounter to support the method by which an individual was admitted into hospital.

Table View

Encounter.id[0]	UKCore-Extension-AdmissionMethod-Example
Encounter.status[0]	finished
Encounter.class[0].system[0]	http://terminology.hl7.org/CodeSystem/v3-ActCode
Encounter.class[0].code[0]	IMP
Encounter.class[0].display[0]	inpatient encounter
Encounter.hospitalization[0].extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdmissionMethod
Encounter.hospitalization[0].extension[0].value[0].coding[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-AdmissionMethodEngland
Encounter.hospitalization[0].extension[0].value[0].coding[0].code[0]	13
Encounter.hospitalization[0].extension[0].value[0].coding[0].display[0]	Elective Admission: Planned

XML View

<Encounter xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-AdmissionMethod-Example" />
    <status value="finished" />
    <class>
        <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode" />
        <code value="IMP" />
        <display value="inpatient encounter" />
    </class>
    <hospitalization>
        <!--  **************extension start**************  -->
        <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdmissionMethod">
            <valueCodeableConcept>
                <coding>
                    <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-AdmissionMethodEngland" />
                    <code value="13" />
                    <display value="Elective Admission: Planned" />
                </coding>
            </valueCodeableConcept>
        </extension>
        <!--  **************extension end**************  -->
    </hospitalization>
</Encounter>

JSON View

{
    "resourceType": "Encounter",
    "id": "UKCore-Extension-AdmissionMethod-Example",
    "status": "finished",
    "class": {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
        "code": "IMP",
        "display": "inpatient encounter"
    },
    "hospitalization": {
        "extension":  [
            {
                "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdmissionMethod",
                "valueCodeableConcept": {
                    "coding":  [
                        {
                            "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-AdmissionMethodEngland",
                            "code": "13",
                            "display": "Elective Admission: Planned"
                        }
                    ]
                }
            }
        ]
    }
}

An example to illustrate the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid

Table View

AllergyIntolerance.id[0]	UKCore-Extension-AllergyIntolEnd-Example
AllergyIntolerance.clinicalStatus[0].extension[0].extension[0].url[0]	endDate
AllergyIntolerance.clinicalStatus[0].extension[0].extension[0].value[0]	2021-07-20T17:10:00+00:00
AllergyIntolerance.clinicalStatus[0].extension[0].extension[1].url[0]	reasonEnded
AllergyIntolerance.clinicalStatus[0].extension[0].extension[1].value[0]	Administrative error corrected on patient record - confirmed that allergy not experienced with the patient.
AllergyIntolerance.clinicalStatus[0].extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd
AllergyIntolerance.clinicalStatus[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
AllergyIntolerance.clinicalStatus[0].coding[0].code[0]	inactive
AllergyIntolerance.clinicalStatus[0].coding[0].display[0]	Inactive
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

XML View

<AllergyIntolerance xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-AllergyIntolEnd-Example" />
    <clinicalStatus>
        <!--  **************extension start**************  -->
        <!-- This supports the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid.. -->
        <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd">
            <extension url="endDate">
                <valueDateTime value="2021-07-20T17:10:00+00:00" />
            </extension>
            <extension url="reasonEnded">
                <valueString value="Administrative error corrected on patient record - confirmed that allergy not experienced with the patient." />
            </extension>
        </extension>
        <!--  **************extension end**************  -->
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical" />
            <code value="inactive" />
            <display value="Inactive" />
        </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>
</AllergyIntolerance>

JSON View

{
    "resourceType": "AllergyIntolerance",
    "id": "UKCore-Extension-AllergyIntolEnd-Example",
    "clinicalStatus": {
        "extension":  [
            {
                "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd",
                "extension":  [
                    {
                        "url": "endDate",
                        "valueDateTime": "2021-07-20T17:10:00+00:00"
                    },
                    {
                        "url": "reasonEnded",
                        "valueString": "Administrative error corrected on patient record - confirmed that allergy not experienced with the patient."
                    }
                ]
            }
        ],
        "coding":  [
            {
                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                "code": "inactive",
                "display": "Inactive"
            }
        ]
    },
    "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"
    }
}

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

Table View

FamilyMemberHistory.id[0]	UKCore-Extension-AssociatedEncounter-Example
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

XML View

<FamilyMemberHistory xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-AssociatedEncounter-Example" />
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AssociatedEncounter">
        <valueReference>
            <reference value="Encounter/UKCore-Encounter-InpatientEncounter-Example" />
        </valueReference>
    </extension>
    <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",
    "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"
            }
        }
    ]
}

An example to illustrate the registered place of birth of the patient using the core-defined extension

Table View

Patient.id[0]	UKCore-Extension-BirthPlace-Example
Patient.extension[0].url[0]	http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.extension[0].value[0].line[0]	MATERNITY UNIT
Patient.extension[0].value[0].line[1]	LENVILLE UNIVERSITY HOSPITAL
Patient.extension[0].value[0].line[2]	BEWLEY STREET
Patient.extension[0].value[0].city[0]	LENVILLE
Patient.extension[0].value[0].postalCode[0]	LEN 7TF
Patient.extension[0].value[0].country[0]	ENGLAND

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-BirthPlace-Example" />
    <!--  **************extension start**************  -->
    <extension url="http://hl7.org/fhir/StructureDefinition/patient-birthPlace">
        <valueAddress>
            <line value="MATERNITY UNIT" />
            <line value="LENVILLE UNIVERSITY HOSPITAL" />
            <line value="BEWLEY STREET" />
            <city value="LENVILLE" />
            <postalCode value="LEN 7TF" />
            <country value="ENGLAND" />
        </valueAddress>
    </extension>
    <!--  **************extension end**************  -->
</Patient>

JSON View

{
    "resourceType": "Patient",
    "id": "UKCore-Extension-BirthPlace-Example",
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/patient-birthPlace",
            "valueAddress": {
                "line":  [
                    "MATERNITY UNIT",
                    "LENVILLE UNIVERSITY HOSPITAL",
                    "BEWLEY STREET"
                ],
                "city": "LENVILLE",
                "postalCode": "LEN 7TF",
                "country": "ENGLAND"
            }
        }
    ]
}

An example to illustrate the extension for a patient's birth sex

Table View

Patient.id[0]	UKCore-Extension-BirthSex-Example
Patient.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex
Patient.extension[0].value[0]	F

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-BirthSex-Example" />
    <!--  **************extension start**************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex">
        <valueCode value="F" />
    </extension>
    <!--  **************extension end**************  -->
</Patient>

JSON View

{
    "resourceType": "Patient",
    "id": "UKCore-Extension-BirthSex-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex",
            "valueCode": "F"
        }
    ]
}

An example to illustrate the patient's birth time using the core-defined extension

Table View

Patient.id[0]	UKCore-Extension-BirthTime-Example
Patient.birthDate[0].extension[0].url[0]	http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.birthDate[0].extension[0].value[0]	2002-03-11T15:39:00+00:00

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-BirthTime-Example" />
    <!--  **************extension start**************  -->
    <birthDate>
        <extension url="http://hl7.org/fhir/StructureDefinition/patient-birthTime">
            <valueDateTime value="2002-03-11T15:39:00+00:00" />
        </extension>
    </birthDate>
    <!--  **************extension end**************  -->
</Patient>

JSON View

{
    "resourceType": "Patient",
    "id": "UKCore-Extension-BirthTime-Example",
    "_birthDate": {
        "extension":  [
            {
                "url": "http://hl7.org/fhir/StructureDefinition/patient-birthTime",
                "valueDateTime": "2002-03-11T15:39:00+00:00"
            }
        ]
    }
}

An example to illustrate the use of the BodySiteReference extension.

Table View

Specimen.id[0]	UKCore-Extension-BodySiteReference-Example
Specimen.status[0]	available
Specimen.type[0].coding[0].system[0]	http://snomed.info/sct
Specimen.type[0].coding[0].code[0]	119297000
Specimen.type[0].coding[0].display[0]	Blood specimen
Specimen.subject[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example
Specimen.receivedTime[0]	2016-02-05T11:10:00Z
Specimen.collection[0].collector[0].reference[0]	Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example
Specimen.collection[0].collected[0]	2016-02-09T16:00:00Z
Specimen.collection[0].method[0].coding[0].system[0]	http://snomed.info/sct
Specimen.collection[0].method[0].coding[0].code[0]	28520004
Specimen.collection[0].method[0].coding[0].display[0]	Venipuncture for blood test
Specimen.collection[0].bodySite[0].extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BodySiteReference
Specimen.collection[0].bodySite[0].extension[0].value[0].reference[0]	BodyStructure/UKCore-BodyStructure-MedianCubitalVeinExample
Specimen.collection[0].bodySite[0].text[0]	vein on the inner left arm

XML View

<Specimen xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-BodySiteReference-Example" />
    <status value="available" />
    <type>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="119297000" />
            <display value="Blood specimen" />
        </coding>
    </type>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <receivedTime value="2016-02-05T11:10:00Z" />
    <collection>
        <collector>
            <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" />
        </collector>
        <collectedDateTime value="2016-02-09T16:00:00Z" />
        <method>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="28520004" />
                <display value="Venipuncture for blood test" />
            </coding>
        </method>
        <bodySite>
            <!--  Use of the bodySite R5 backport extension to reference a BodyStructure, in this case, the draw site.  -->
            <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BodySiteReference">
                <valueReference>
                    <reference value="BodyStructure/UKCore-BodyStructure-MedianCubitalVeinExample" />
                </valueReference>
            </extension>
            <text value="vein on the inner left arm" />
        </bodySite>
    </collection>
</Specimen>

JSON View

{
    "resourceType": "Specimen",
    "id": "UKCore-Extension-BodySiteReference-Example",
    "status": "available",
    "type": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "119297000",
                "display": "Blood specimen"
            }
        ]
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "receivedTime": "2016-02-05T11:10:00Z",
    "collection": {
        "collector": {
            "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example"
        },
        "collectedDateTime": "2016-02-09T16:00:00Z",
        "method": {
            "coding":  [
                {
                    "system": "http://snomed.info/sct",
                    "code": "28520004",
                    "display": "Venipuncture for blood test"
                }
            ]
        },
        "bodySite": {
            "extension":  [
                {
                    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BodySiteReference",
                    "valueReference": {
                        "reference": "BodyStructure/UKCore-BodyStructure-MedianCubitalVeinExample"
                    }
                }
            ],
            "text": "vein on the inner left arm"
        }
    }
}

An example to illustrate the booking organization extension associated with an appointment

Table View

Appointment.id[0]	UKCore-Extension-BookingOrganization-Example
Appointment.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BookingOrganization
Appointment.extension[0].value[0].reference[0]	Organization/UKCore-Organization-WhiteRoseMedicalCentre-Example
Appointment.extension[0].value[0].type[0]	Organization
Appointment.extension[0].value[0].identifier[0].use[0]	official
Appointment.extension[0].value[0].identifier[0].type[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/v2-0203
Appointment.extension[0].value[0].identifier[0].type[0].coding[0].code[0]	PRN
Appointment.extension[0].value[0].identifier[0].type[0].coding[0].display[0]	Provider number
Appointment.extension[0].value[0].identifier[0].system[0]	https://fhir.nhs.uk/Id/ods-site-code
Appointment.extension[0].value[0].identifier[0].value[0]	GP8D7
Appointment.extension[0].value[0].identifier[0].period[0].start[0]	2022-03-11T10:46:00+00:00
Appointment.extension[0].value[0].identifier[0].period[0].end[0]	2022-03-11T13:20:00+00:00
Appointment.status[0]	booked
Appointment.start[0]	2022-03-11T10:46:00+00:00
Appointment.end[0]	2022-03-11T13:20:00+00:00
Appointment.participant[0].actor[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example
Appointment.participant[0].actor[0].display[0]	Richard Smith
Appointment.participant[0].required[0]	required
Appointment.participant[0].status[0]	accepted
Appointment.participant[1].type[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/v3-ParticipationType
Appointment.participant[1].type[0].coding[0].code[0]	ATND
Appointment.participant[1].actor[0].reference[0]	Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example
Appointment.participant[1].actor[0].display[0]	Dr Sandra Gose
Appointment.participant[1].required[0]	required
Appointment.participant[1].status[0]	accepted
Appointment.participant[2].actor[0].reference[0]	Location/UKCore-Location-HospitalSJUH-Example
Appointment.participant[2].actor[0].display[0]	Orthopaedic Trauma Department, St James' University Hospital, Leeds
Appointment.participant[2].required[0]	required
Appointment.participant[2].status[0]	accepted

XML View

<Appointment xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-BookingOrganization-Example" />
    <!--  ***************extension start***************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BookingOrganization">
        <valueReference>
            <reference value="Organization/UKCore-Organization-WhiteRoseMedicalCentre-Example" />
            <type value="Organization" />
            <identifier>
                <use value="official" />
                <type>
                    <coding>
                        <system value="http://terminology.hl7.org/CodeSystem/v2-0203" />
                        <code value="PRN" />
                        <display value="Provider number" />
                    </coding>
                </type>
                <system value="https://fhir.nhs.uk/Id/ods-site-code" />
                <value value="GP8D7" />
                <period>
                    <start value="2022-03-11T10:46:00+00:00" />
                    <end value="2022-03-11T13:20:00+00:00" />
                </period>
            </identifier>
        </valueReference>
    </extension>
    <!--  **************extension end ******************  -->
    <status value="booked" />
    <start value="2022-03-11T10:46:00+00:00" />
    <end value="2022-03-11T13:20:00+00:00" />
    <participant>
        <actor>
            <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
            <display value="Richard Smith" />
        </actor>
        <required value="required" />
        <status value="accepted" />
    </participant>
    <participant>
        <type>
            <coding>
                <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType" />
                <code value="ATND" />
            </coding>
        </type>
        <actor>
            <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" />
            <display value="Dr Sandra Gose" />
        </actor>
        <required value="required" />
        <status value="accepted" />
    </participant>
    <participant>
        <actor>
            <reference value="Location/UKCore-Location-HospitalSJUH-Example" />
            <display value="Orthopaedic Trauma Department, St James&#39; University Hospital, Leeds" />
        </actor>
        <required value="required" />
        <status value="accepted" />
    </participant>
</Appointment>

JSON View

{
    "resourceType": "Appointment",
    "id": "UKCore-Extension-BookingOrganization-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BookingOrganization",
            "valueReference": {
                "reference": "Organization/UKCore-Organization-WhiteRoseMedicalCentre-Example",
                "type": "Organization",
                "identifier": {
                    "use": "official",
                    "type": {
                        "coding":  [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                "code": "PRN",
                                "display": "Provider number"
                            }
                        ]
                    },
                    "system": "https://fhir.nhs.uk/Id/ods-site-code",
                    "value": "GP8D7",
                    "period": {
                        "start": "2022-03-11T10:46:00+00:00",
                        "end": "2022-03-11T13:20:00+00:00"
                    }
                }
            }
        }
    ],
    "status": "booked",
    "start": "2022-03-11T10:46:00+00:00",
    "end": "2022-03-11T13:20:00+00:00",
    "participant":  [
        {
            "actor": {
                "reference": "Patient/UKCore-Patient-RichardSmith-Example",
                "display": "Richard Smith"
            },
            "required": "required",
            "status": "accepted"
        },
        {
            "type":  [
                {
                    "coding":  [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                            "code": "ATND"
                        }
                    ]
                }
            ],
            "actor": {
                "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example",
                "display": "Dr Sandra Gose"
            },
            "required": "required",
            "status": "accepted"
        },
        {
            "actor": {
                "reference": "Location/UKCore-Location-HospitalSJUH-Example",
                "display": "Orthopaedic Trauma Department, St James' University Hospital, Leeds"
            },
            "required": "required",
            "status": "accepted"
        }
    ]
}

An example to illustrate whether the patient authorised the donation of body parts after death using the core-defined extension

Table View

Patient.id[0]	UKCore-Extension-CadavericDonor-Example
Patient.extension[0].url[0]	http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
Patient.extension[0].value[0]	True

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-CadavericDonor-Example" />
    <!--  **************extension start**************  -->
    <extension url="http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor">
        <valueBoolean value="true" />
    </extension>
    <!--  **************extension end**************  -->
</Patient>

JSON View

{
    "resourceType": "Patient",
    "id": "UKCore-Extension-CadavericDonor-Example",
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor",
            "valueBoolean": true
        }
    ]
}

An example to illustrate the care setting of a FHIR document

Table View

Composition.id[0]	UKCore-Extension-CareSettingType-Example
Composition.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType
Composition.extension[0].value[0].coding[0].system[0]	http://snomed.info/sct
Composition.extension[0].value[0].coding[0].code[0]	789718008
Composition.extension[0].value[0].coding[0].display[0]	Cardiology service
Composition.status[0]	final
Composition.type[0].coding[0].system[0]	http://snomed.info/sct
Composition.type[0].coding[0].code[0]	373942005
Composition.type[0].coding[0].display[0]	Discharge summary
Composition.date[0]	2020-11-11T21:30:00+00:00
Composition.author[0].reference[0]	urn:uuid:6555b7a7-380d-46ff-a1c5-7abc4e68f8bc
Composition.title[0]	Discharge summary

XML View

<Composition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-CareSettingType-Example" />
    <!--  **************extension start**************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType">
        <valueCodeableConcept>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="789718008" />
                <display value="Cardiology service" />
            </coding>
        </valueCodeableConcept>
    </extension>
    <!--  *************extension end ***************** -->
    <status value="final" />
    <type>
        <!-- Discharge Summary document type -->
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="373942005" />
            <display value="Discharge summary" />
        </coding>
    </type>
    <date value="2020-11-11T21:30:00+00:00" />
    <author>
        <reference value="urn:uuid:6555b7a7-380d-46ff-a1c5-7abc4e68f8bc" />
    </author>
    <title value="Discharge summary" />
</Composition>

JSON View

{
    "resourceType": "Composition",
    "id": "UKCore-Extension-CareSettingType-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "789718008",
                        "display": "Cardiology service"
                    }
                ]
            }
        }
    ],
    "status": "final",
    "type": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "373942005",
                "display": "Discharge summary"
            }
        ]
    },
    "date": "2020-11-11T21:30:00+00:00",
    "author":  [
        {
            "reference": "urn:uuid:6555b7a7-380d-46ff-a1c5-7abc4e68f8bc"
        }
    ],
    "title": "Discharge summary"
}

An example to illustrate the extension which adds a SNOMED CT description ID to CodeableConcept

Table View

Condition.id[0]	UKCore-Extension-CodingSCTDescId-Example
Condition.code[0].coding[0].extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescDisplay
Condition.code[0].coding[0].extension[0].value[0]	Bronchial asthma
Condition.code[0].coding[0].extension[1].url[0]	http://hl7.org/fhir/StructureDefinition/coding-sctdescid
Condition.code[0].coding[0].extension[1].value[0]	301480018
Condition.code[0].coding[0].system[0]	http://snomed.info/sct
Condition.code[0].coding[0].code[0]	195967001
Condition.code[0].coding[0].display[0]	Asthma
Condition.code[0].coding[0].userSelected[0]	True
Condition.subject[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example

XML View

<Condition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-CodingSCTDescId-Example" />
    <code>
        <coding>
            <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescDisplay">
                <valueString value="Bronchial asthma" />
            </extension>
            <extension url="http://hl7.org/fhir/StructureDefinition/coding-sctdescid">
                <valueId value="301480018" />
            </extension>
            <system value="http://snomed.info/sct" />
            <code value="195967001" />
            <display value="Asthma" />
            <userSelected value="true" />
        </coding>
    </code>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
</Condition>

JSON View

{
    "resourceType": "Condition",
    "id": "UKCore-Extension-CodingSCTDescId-Example",
    "code": {
        "coding":  [
            {
                "extension":  [
                    {
                        "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescDisplay",
                        "valueString": "Bronchial asthma"
                    },
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/coding-sctdescid",
                        "valueId": "301480018"
                    }
                ],
                "system": "http://snomed.info/sct",
                "code": "195967001",
                "display": "Asthma",
                "userSelected": true
            }
        ]
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    }
}

An example to illustrate the pre-adopted R5 element via an extension, which is used to reference a Patient or RelatedPerson within Specimen.collection.collector.

Table View

Specimen.id[0]	UKCore-Extension-CollectionCollector-Example
Specimen.status[0]	available
Specimen.type[0].coding[0].system[0]	http://snomed.info/sct
Specimen.type[0].coding[0].code[0]	78014005
Specimen.type[0].coding[0].display[0]	Urine
Specimen.subject[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example
Specimen.receivedTime[0]	2022-11-25T11:10:00Z
Specimen.collection[0].collector[0].extension[0].url[0]	http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.collector
Specimen.collection[0].collector[0].extension[0].value[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example
Specimen.collection[0].collected[0]	2022-11-25T16:00:00Z

XML View

<Specimen xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-CollectionCollector-Example" />
    <status value="available" />
    <type>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="78014005" />
            <display value="Urine" />
        </coding>
    </type>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <receivedTime value="2022-11-25T11:10:00Z" />
    <collection>
        <collector>
            <!--   ***************extension start***************   -->
            <extension url="http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.collector">
                <valueReference>
                    <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
                </valueReference>
            </extension>
            <!--   **************extension end ******************   -->
        </collector>
        <collectedDateTime value="2022-11-25T16:00:00Z" />
    </collection>
</Specimen>

JSON View

{
    "resourceType": "Specimen",
    "id": "UKCore-Extension-CollectionCollector-Example",
    "status": "available",
    "type": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "78014005",
                "display": "Urine"
            }
        ]
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "receivedTime": "2022-11-25T11:10:00Z",
    "collection": {
        "collector": {
            "extension":  [
                {
                    "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.collector",
                    "valueReference": {
                        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
                    }
                }
            ]
        },
        "collectedDateTime": "2022-11-25T16:00:00Z"
    }
}

An example to illustrate referencing a composition within a diagnostic report

Table View

DiagnosticReport.id[0]	UKCore-Extension-CompositionReference-Example
DiagnosticReport.extension[0].url[0]	http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition
DiagnosticReport.extension[0].value[0].reference[0]	Composition/UKCore-Composition-Discharge-Example
DiagnosticReport.identifier[0].system[0]	https://tools.ietf.org/html/rfc4122
DiagnosticReport.identifier[0].value[0]	ce1913bf-ead4-4d04-904f-714cbc1636ef
DiagnosticReport.status[0]	final
DiagnosticReport.code[0].coding[0].system[0]	http://snomed.info/sct
DiagnosticReport.code[0].coding[0].code[0]	252275004
DiagnosticReport.code[0].coding[0].display[0]	Hematology test
DiagnosticReport.subject[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example
DiagnosticReport.performer[0].reference[0]	Organization/UKCore-Organization-LeedsTeachingHospital-Example
DiagnosticReport.performer[0].display[0]	LEEDS TEACHING HOSPITALS NHS TRUST

XML View

<DiagnosticReport xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-CompositionReference-Example" />
    <extension url="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition">
        <valueReference>
            <reference value="Composition/UKCore-Composition-Discharge-Example" />
        </valueReference>
    </extension>
    <identifier>
        <system value="https://tools.ietf.org/html/rfc4122" />
        <value value="ce1913bf-ead4-4d04-904f-714cbc1636ef" />
    </identifier>
    <status value="final" />
    <code>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="252275004" />
            <display value="Hematology test" />
        </coding>
    </code>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <performer>
        <reference value="Organization/UKCore-Organization-LeedsTeachingHospital-Example" />
        <display value="LEEDS TEACHING HOSPITALS NHS TRUST" />
    </performer>
</DiagnosticReport>

JSON View

{
    "resourceType": "DiagnosticReport",
    "id": "UKCore-Extension-CompositionReference-Example",
    "extension":  [
        {
            "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition",
            "valueReference": {
                "reference": "Composition/UKCore-Composition-Discharge-Example"
            }
        }
    ],
    "identifier":  [
        {
            "system": "https://tools.ietf.org/html/rfc4122",
            "value": "ce1913bf-ead4-4d04-904f-714cbc1636ef"
        }
    ],
    "status": "final",
    "code": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "252275004",
                "display": "Hematology test"
            }
        ]
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "performer":  [
        {
            "reference": "Organization/UKCore-Organization-LeedsTeachingHospital-Example",
            "display": "LEEDS TEACHING HOSPITALS NHS TRUST"
        }
    ]
}

An example to illustrate the extension which is used to indicate the episodicity status of a condition

Table View

Condition.id[0]	UKCore-Extension-ConditionEpisode-Example
Condition.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ConditionEpisode
Condition.extension[0].value[0]	new
Condition.subject[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example

XML View

<Condition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-ConditionEpisode-Example" />
    <!--   **************extension start**************   -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ConditionEpisode">
        <valueCode value="new" />
    </extension>
    <!--   **************extension end**************   -->
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
</Condition>

JSON View

{
    "resourceType": "Condition",
    "id": "UKCore-Extension-ConditionEpisode-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ConditionEpisode",
            "valueCode": "new"
        }
    ],
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    }
}

An example to illustrate the extension for a patient's contact preferences

Table View

Patient.id[0]	UKCore-Extension-ContactPreference-Example
Patient.extension[0].extension[0].url[0]	PreferredContactMethod
Patient.extension[0].extension[0].value[0].coding[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod
Patient.extension[0].extension[0].value[0].coding[0].code[0]	3
Patient.extension[0].extension[0].value[0].coding[0].display[0]	Telephone
Patient.extension[0].extension[1].url[0]	PreferredContactTimes
Patient.extension[0].extension[1].value[0].repeat[0].frequency[0]	1
Patient.extension[0].extension[1].value[0].repeat[0].period[0]	1
Patient.extension[0].extension[1].value[0].repeat[0].periodUnit[0]	d
Patient.extension[0].extension[1].value[0].repeat[0].dayOfWeek[0]	mon
Patient.extension[0].extension[1].value[0].repeat[0].dayOfWeek[1]	wed
Patient.extension[0].extension[1].value[0].repeat[0].dayOfWeek[2]	fri
Patient.extension[0].extension[1].value[0].repeat[0].when[0]	MORN
Patient.extension[0].extension[2].url[0]	PreferredWrittenCommunicationFormat
Patient.extension[0].extension[2].value[0].coding[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat
Patient.extension[0].extension[2].value[0].coding[0].code[0]	11
Patient.extension[0].extension[2].value[0].coding[0].display[0]	Large print
Patient.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-ContactPreference-Example" />
    <!--  **************extension start**************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference">
        <extension url="PreferredContactMethod">
            <valueCodeableConcept>
                <coding>
                    <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod" />
                    <code value="3" />
                    <display value="Telephone" />
                </coding>
            </valueCodeableConcept>
        </extension>
        <extension url="PreferredContactTimes">
            <valueTiming>
                <repeat>
                    <frequency value="1" />
                    <period value="1" />
                    <periodUnit value="d" />
                    <dayOfWeek value="mon" />
                    <dayOfWeek value="wed" />
                    <dayOfWeek value="fri" />
                    <when value="MORN" />
                </repeat>
            </valueTiming>
        </extension>
        <extension url="PreferredWrittenCommunicationFormat">
            <valueCodeableConcept>
                <coding>
                    <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat" />
                    <code value="11" />
                    <display value="Large print" />
                </coding>
            </valueCodeableConcept>
        </extension>
    </extension>
    <!--  **************extension end**************  -->
</Patient>

JSON View

{
    "resourceType": "Patient",
    "id": "UKCore-Extension-ContactPreference-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference",
            "extension":  [
                {
                    "url": "PreferredContactMethod",
                    "valueCodeableConcept": {
                        "coding":  [
                            {
                                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod",
                                "code": "3",
                                "display": "Telephone"
                            }
                        ]
                    }
                },
                {
                    "url": "PreferredContactTimes",
                    "valueTiming": {
                        "repeat": {
                            "frequency": 1,
                            "period": 1,
                            "periodUnit": "d",
                            "dayOfWeek":  [
                                "mon",
                                "wed",
                                "fri"
                            ],
                            "when":  [
                                "MORN"
                            ]
                        }
                    }
                },
                {
                    "url": "PreferredWrittenCommunicationFormat",
                    "valueCodeableConcept": {
                        "coding":  [
                            {
                                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat",
                                "code": "11",
                                "display": "Large print"
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

An example to illustrate the extension for the patient's contact ranking

This example shows the extension which uses a PositiveInt to indicate the order that the people listed as contacts for the patient should be contacted. This example uses the value 1 to show that this is the first person who should be contacted.

Table View

Patient.id[0]	UKCore-Extension-ContactRank-Example
Patient.contact[0].extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank
Patient.contact[0].extension[0].value[0]	1
Patient.contact[0].name[0].use[0]	official
Patient.contact[0].name[0].family[0]	CARTER
Patient.contact[0].name[0].given[0]	Emily
Patient.contact[0].telecom[0].system[0]	phone
Patient.contact[0].telecom[0].value[0]	01131231288
Patient.contact[0].gender[0]	female

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-ContactRank-Example" />
    <contact>
        <!--  **************extension start**************  -->
        <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank">
            <valuePositiveInt value="1" />
        </extension>
        <!--  **************extension end**************  -->
        <name>
            <use value="official" />
            <family value="CARTER" />
            <given value="Emily" />
        </name>
        <telecom>
            <system value="phone" />
            <value value="01131231288" />
        </telecom>
        <gender value="female" />
    </contact>
</Patient>

JSON View

{
    "resourceType": "Patient",
    "id": "UKCore-Extension-ContactRank-Example",
    "contact":  [
        {
            "extension":  [
                {
                    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank",
                    "valuePositiveInt": 1
                }
            ],
            "name": {
                "use": "official",
                "family": "CARTER",
                "given":  [
                    "Emily"
                ]
            },
            "telecom":  [
                {
                    "system": "phone",
                    "value": "01131231288"
                }
            ],
            "gender": "female"
        }
    ]
}

An example to illustrate the extension for copy correspondence indicators

Table View

Patient.id[0]	UKCore-Extension-CopyCorrespondenceIndicator-Example
Patient.contact[0].extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
Patient.contact[0].extension[0].value[0]	True
Patient.contact[0].name[0].use[0]	official
Patient.contact[0].name[0].family[0]	CARTER
Patient.contact[0].name[0].given[0]	Emily
Patient.contact[0].telecom[0].system[0]	phone
Patient.contact[0].telecom[0].value[0]	01131231288
Patient.contact[0].gender[0]	female

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-CopyCorrespondenceIndicator-Example" />
    <contact>
        <!--  **************extension start**************  -->
        <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator">
            <valueBoolean value="true" />
        </extension>
        <!--  **************extension end**************  -->
        <name>
            <use value="official" />
            <family value="CARTER" />
            <given value="Emily" />
        </name>
        <telecom>
            <system value="phone" />
            <value value="01131231288" />
        </telecom>
        <gender value="female" />
    </contact>
</Patient>

JSON View

{
    "resourceType": "Patient",
    "id": "UKCore-Extension-CopyCorrespondenceIndicator-Example",
    "contact":  [
        {
            "extension":  [
                {
                    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator",
                    "valueBoolean": true
                }
            ],
            "name": {
                "use": "official",
                "family": "CARTER",
                "given":  [
                    "Emily"
                ]
            },
            "telecom":  [
                {
                    "system": "phone",
                    "value": "01131231288"
                }
            ],
            "gender": "female"
        }
    ]
}

An example to illustrate sending an NHS or Private funding category with a service request

Table View

ServiceRequest.id[0]	UKCore-Extension-Coverage-Example
ServiceRequest.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage
ServiceRequest.extension[0].value[0].coding[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-FundingCategory
ServiceRequest.extension[0].value[0].coding[0].code[0]	private
ServiceRequest.extension[0].value[0].coding[0].display[0]	Private
ServiceRequest.status[0]	active
ServiceRequest.intent[0]	order
ServiceRequest.subject[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example

XML View

<ServiceRequest xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-Coverage-Example" />
    <!--  ***************extension start***************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage">
        <valueCodeableConcept>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-FundingCategory" />
                <code value="private" />
                <display value="Private" />
            </coding>
        </valueCodeableConcept>
    </extension>
    <!--  **************extension end ******************  -->
    <status value="active" />
    <intent value="order" />
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
</ServiceRequest>

JSON View

{
    "resourceType": "ServiceRequest",
    "id": "UKCore-Extension-Coverage-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-FundingCategory",
                        "code": "private",
                        "display": "Private"
                    }
                ]
            }
        }
    ],
    "status": "active",
    "intent": "order",
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    }
}

An example to illustrate recording a blood pressure device with a large cuff

Table View

Device.id[0]	UKCore-Extension-CuffSize-Example
Device.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CuffSize
Device.extension[0].value[0].coding[0].system[0]	http://snomed.info/sct
Device.extension[0].value[0].coding[0].code[0]	990191000000101
Device.extension[0].value[0].coding[0].display[0]	Large adult size blood pressure cuff
Device.status[0]	active
Device.type[0].coding[0].system[0]	http://snomed.info/sct
Device.type[0].coding[0].code[0]	39690000
Device.type[0].coding[0].display[0]	Sphygmomanometer

XML View

<Device xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-CuffSize-Example" />
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CuffSize">
        <valueCodeableConcept>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="990191000000101" />
                <display value="Large adult size blood pressure cuff" />
            </coding>
        </valueCodeableConcept>
    </extension>
    <status value="active" />
    <type>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="39690000" />
            <display value="Sphygmomanometer" />
        </coding>
    </type>
</Device>

JSON View

{
    "resourceType": "Device",
    "id": "UKCore-Extension-CuffSize-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CuffSize",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "990191000000101",
                        "display": "Large adult size blood pressure cuff"
                    }
                ]
            }
        }
    ],
    "status": "active",
    "type": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "39690000",
                "display": "Sphygmomanometer"
            }
        ]
    }
}

An example to illustrate the extension to indicate the death notification status of the patient

Table View

Patient.id[0]	UKCore-Extension-DeathNotificationStatus-Example
Patient.extension[0].extension[0].url[0]	deathNotificationStatus
Patient.extension[0].extension[0].value[0].coding[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-DeathNotificationStatus
Patient.extension[0].extension[0].value[0].coding[0].code[0]	U
Patient.extension[0].extension[0].value[0].coding[0].display[0]	Removed
Patient.extension[0].extension[1].url[0]	systemEffectiveDate
Patient.extension[0].extension[1].value[0]	2019-08-01T00:00:00.000Z
Patient.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-DeathNotificationStatus-Example" />
    <!--  **************extension start**************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus">
        <extension url="deathNotificationStatus">
            <valueCodeableConcept>
                <coding>
                    <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-DeathNotificationStatus" />
                    <code value="U" />
                    <display value="Removed" />
                </coding>
            </valueCodeableConcept>
        </extension>
        <extension url="systemEffectiveDate">
            <valueDateTime value="2019-08-01T00:00:00.000Z" />
        </extension>
    </extension>
    <!--  **************extension end**************  -->
</Patient>

JSON View

{
    "resourceType": "Patient",
    "id": "UKCore-Extension-DeathNotificationStatus-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus",
            "extension":  [
                {
                    "url": "deathNotificationStatus",
                    "valueCodeableConcept": {
                        "coding":  [
                            {
                                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-DeathNotificationStatus",
                                "code": "U",
                                "display": "Removed"
                            }
                        ]
                    }
                },
                {
                    "url": "systemEffectiveDate",
                    "valueDateTime": "2019-08-01T00:00:00.000Z"
                }
            ]
        }
    ]
}

An example to illustrate the delivery channel associated with an appointment

Table View

Appointment.id[0]	UKCore-Extension-DeliveryChannel-Example
Appointment.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel
Appointment.extension[0].value[0]	In-person
Appointment.status[0]	booked
Appointment.start[0]	2022-03-11T10:46:00+00:00
Appointment.end[0]	2022-03-11T13:20:00+00:00
Appointment.participant[0].actor[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example
Appointment.participant[0].actor[0].display[0]	Richard Smith
Appointment.participant[0].required[0]	required
Appointment.participant[0].status[0]	accepted
Appointment.participant[1].type[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/v3-ParticipationType
Appointment.participant[1].type[0].coding[0].code[0]	ATND
Appointment.participant[1].actor[0].reference[0]	Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example
Appointment.participant[1].actor[0].display[0]	Dr Sandra Gose
Appointment.participant[1].required[0]	required
Appointment.participant[1].status[0]	accepted
Appointment.participant[2].actor[0].reference[0]	Location/UKCore-Location-HospitalSJUH-Example
Appointment.participant[2].actor[0].display[0]	Orthopaedic Trauma Department, St James' University Hospital, Leeds
Appointment.participant[2].required[0]	required
Appointment.participant[2].status[0]	accepted

XML View

<Appointment xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-DeliveryChannel-Example" />
    <!--  ***************extension start***************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel">
        <valueCode value="In-person" />
    </extension>
    <!--  **************extension end ******************  -->
    <status value="booked" />
    <start value="2022-03-11T10:46:00+00:00" />
    <end value="2022-03-11T13:20:00+00:00" />
    <participant>
        <actor>
            <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
            <display value="Richard Smith" />
        </actor>
        <required value="required" />
        <status value="accepted" />
    </participant>
    <participant>
        <type>
            <coding>
                <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType" />
                <code value="ATND" />
            </coding>
        </type>
        <actor>
            <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" />
            <display value="Dr Sandra Gose" />
        </actor>
        <required value="required" />
        <status value="accepted" />
    </participant>
    <participant>
        <actor>
            <reference value="Location/UKCore-Location-HospitalSJUH-Example" />
            <display value="Orthopaedic Trauma Department, St James&#39; University Hospital, Leeds" />
        </actor>
        <required value="required" />
        <status value="accepted" />
    </participant>
</Appointment>

JSON View

{
    "resourceType": "Appointment",
    "id": "UKCore-Extension-DeliveryChannel-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel",
            "valueCode": "In-person"
        }
    ],
    "status": "booked",
    "start": "2022-03-11T10:46:00+00:00",
    "end": "2022-03-11T13:20:00+00:00",
    "participant":  [
        {
            "actor": {
                "reference": "Patient/UKCore-Patient-RichardSmith-Example",
                "display": "Richard Smith"
            },
            "required": "required",
            "status": "accepted"
        },
        {
            "type":  [
                {
                    "coding":  [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                            "code": "ATND"
                        }
                    ]
                }
            ],
            "actor": {
                "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example",
                "display": "Dr Sandra Gose"
            },
            "required": "required",
            "status": "accepted"
        },
        {
            "actor": {
                "reference": "Location/UKCore-Location-HospitalSJUH-Example",
                "display": "Orthopaedic Trauma Department, St James' University Hospital, Leeds"
            },
            "required": "required",
            "status": "accepted"
        }
    ]
}

An example to illustrate a device performing a diagnostic report

Table View

The resource cannot be rendered.

XML View

<DiagnosticReport xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-DeviceReference-Example" />
    <status value="final" />
    <code>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="721981007" />
            <display value="Diagnostic studies report" />
        </coding>
    </code>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <performer>
        <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference">
            <valueReference>
                <reference value="Device/UKCore-Device-SoftwareAsAMedicalDevice-Example" />
            </valueReference>
        </extension>
        <display value="Software as a medical device" />
    </performer>
    <resultsInterpreter>
        <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference">
            <valueReference>
                <reference value="Device/UKCore-Device-SoftwareAsAMedicalDevice-Example" />
            </valueReference>
        </extension>
        <display value="Software as a medical device" />
    </resultsInterpreter>
    <specimen>
        <reference value="Specimen/UKCore-Specimen-BloodSpecimen-Example" />
    </specimen>
    <result>
        <reference value="Observation/UKCore-Observation-WhiteCellCount-Example" />
    </result>
</DiagnosticReport>

JSON View

{
    "resourceType": "DiagnosticReport",
    "id": "UKCore-Extension-DeviceReference-Example",
    "status": "final",
    "code": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "721981007",
                "display": "Diagnostic studies report"
            }
        ]
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "performer":  [
        {
            "display": "Software as a medical device",
            "extension":  [
                {
                    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference",
                    "valueReference": {
                        "reference": "Device/UKCore-Device-SoftwareAsAMedicalDevice-Example"
                    }
                }
            ]
        }
    ],
    "resultsInterpreter":  [
        {
            "display": "Software as a medical device",
            "extension":  [
                {
                    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference",
                    "valueReference": {
                        "reference": "Device/UKCore-Device-SoftwareAsAMedicalDevice-Example"
                    }
                }
            ]
        }
    ],
    "specimen":  [
        {
            "reference": "Specimen/UKCore-Specimen-BloodSpecimen-Example"
        }
    ],
    "result":  [
        {
            "reference": "Observation/UKCore-Observation-WhiteCellCount-Example"
        }
    ]
}

An example to illustrate the extension for an encounter to support the method of discharge from a hospital.

Table View

Encounter.id[0]	UKCore-Extension-DischargeMethod-Example
Encounter.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DischargeMethod
Encounter.extension[0].value[0].coding[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-DischargeMethodEngland
Encounter.extension[0].value[0].coding[0].code[0]	1
Encounter.extension[0].value[0].coding[0].display[0]	Patient discharged on clinical advice or with clinical consent
Encounter.status[0]	finished
Encounter.class[0].system[0]	http://terminology.hl7.org/CodeSystem/v3-ActCode
Encounter.class[0].code[0]	IMP
Encounter.class[0].display[0]	inpatient encounter

XML View

<Encounter xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-DischargeMethod-Example" />
    <!--  **************extension start**************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DischargeMethod">
        <valueCodeableConcept>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-DischargeMethodEngland" />
                <code value="1" />
                <display value="Patient discharged on clinical advice or with clinical consent" />
            </coding>
        </valueCodeableConcept>
    </extension>
    <!--  **************extension end**************  -->
    <status value="finished" />
    <class>
        <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode" />
        <code value="IMP" />
        <display value="inpatient encounter" />
    </class>
</Encounter>

JSON View

{
    "resourceType": "Encounter",
    "id": "UKCore-Extension-DischargeMethod-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DischargeMethod",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-DischargeMethodEngland",
                        "code": "1",
                        "display": "Patient discharged on clinical advice or with clinical consent"
                    }
                ]
            }
        }
    ],
    "status": "finished",
    "class": {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
        "code": "IMP",
        "display": "inpatient encounter"
    }
}

An example to illustrate the extension which is used to indicate the status of an individual on discharge from an Emergency Care Department

Table View

Encounter.id[0]	UKCore-Extension-EmergencyCareDischargeStatus-Example
Encounter.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EmergencyCareDischargeStatus
Encounter.extension[0].value[0].coding[0].system[0]	http://snomed.info/sct
Encounter.extension[0].value[0].coding[0].code[0]	182992009
Encounter.extension[0].value[0].coding[0].display[0]	Treatment completed
Encounter.status[0]	finished
Encounter.class[0].system[0]	http://terminology.hl7.org/CodeSystem/v3-ActCode
Encounter.class[0].code[0]	IMP
Encounter.class[0].display[0]	inpatient encounter

XML View

<Encounter xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-EmergencyCareDischargeStatus-Example" />
    <!--   **************extension start**************   -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EmergencyCareDischargeStatus">
        <valueCodeableConcept>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="182992009" />
                <display value="Treatment completed" />
            </coding>
        </valueCodeableConcept>
    </extension>
    <!--   **************extension end**************   -->
    <status value="finished" />
    <class>
        <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode" />
        <code value="IMP" />
        <display value="inpatient encounter" />
    </class>
</Encounter>

JSON View

{
    "resourceType": "Encounter",
    "id": "UKCore-Extension-EmergencyCareDischargeStatus-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EmergencyCareDischargeStatus",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "182992009",
                        "display": "Treatment completed"
                    }
                ]
            }
        }
    ],
    "status": "finished",
    "class": {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
        "code": "IMP",
        "display": "inpatient encounter"
    }
}

An example to illustrate the extension which shows the ethnic category for a patient

Table View

Patient.id[0]	UKCore-Extension-EthnicCategory-Example
Patient.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory
Patient.extension[0].value[0].coding[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategoryEngland
Patient.extension[0].value[0].coding[0].code[0]	A
Patient.extension[0].value[0].coding[0].display[0]	White - British

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-EthnicCategory-Example" />
    <!--  **************extension start**************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory">
        <valueCodeableConcept>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategoryEngland" />
                <code value="A" />
                <display value="White - British" />
            </coding>
        </valueCodeableConcept>
    </extension>
    <!--  *************extension end ***************** -->
</Patient>

JSON View

{
    "resourceType": "Patient",
    "id": "UKCore-Extension-EthnicCategory-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategoryEngland",
                        "code": "A",
                        "display": "White - British"
                    }
                ]
            }
        }
    ]
}

An example to illustrate a reference to results of investigations that confirmed the certainty of the diagnosis for an allergy or intolerance

Table View

AllergyIntolerance.id[0]	UKCore-Extension-Evidence-Example
AllergyIntolerance.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence
AllergyIntolerance.extension[0].value[0].reference[0]	DiagnosticReport/UKCore-DiagnosticReport-DiagnosticStudiesReport-Example
AllergyIntolerance.extension[0].value[0].type[0]	DiagnosticReport
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

XML View

<AllergyIntolerance xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-Evidence-Example" />
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence">
        <valueReference>
            <reference value="DiagnosticReport/UKCore-DiagnosticReport-DiagnosticStudiesReport-Example" />
            <type value="DiagnosticReport" />
        </valueReference>
    </extension>
    <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-Extension-Evidence-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence",
            "valueReference": {
                "reference": "DiagnosticReport/UKCore-DiagnosticReport-DiagnosticStudiesReport-Example",
                "type": "DiagnosticReport"
            }
        }
    ],
    "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"
        }
    ]
}

An example to illustrate the core-defined extension which is used to indicate that a person requires an interpreter

Table View

Patient.id[0]	UKCore-Extension-InterpreterRequired-Example
Patient.extension[0].url[0]	http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
Patient.extension[0].value[0]	True

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-InterpreterRequired-Example" />
    <!--   **************extension start**************   -->
    <extension url="http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired">
        <valueBoolean value="true" />
    </extension>
    <!--   **************extension end**************   -->
</Patient>

JSON View

{
    "resourceType": "Patient",
    "id": "UKCore-Extension-InterpreterRequired-Example",
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired",
            "valueBoolean": true
        }
    ]
}

An example to illustrate the extension which is used to indicate a patient's legal status on admission or discharge

Table View

Encounter.id[0]	UKCore-Extension-LegalStatus-Example
Encounter.extension[0].extension[0].url[0]	legalStatusContext
Encounter.extension[0].extension[0].value[0].coding[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-LegalStatusContext
Encounter.extension[0].extension[0].value[0].coding[0].code[0]	admission
Encounter.extension[0].extension[0].value[0].coding[0].display[0]	Admission
Encounter.extension[0].extension[1].url[0]	legalStatusClassification
Encounter.extension[0].extension[1].value[0].coding[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-LegalStatusClassificationWales
Encounter.extension[0].extension[1].value[0].coding[0].code[0]	02
Encounter.extension[0].extension[1].value[0].coding[0].display[0]	Formally detained under Mental Health Act Section 2 (Admission for assessment)
Encounter.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus
Encounter.status[0]	finished
Encounter.class[0].system[0]	http://terminology.hl7.org/CodeSystem/v3-ActCode
Encounter.class[0].code[0]	IMP
Encounter.class[0].display[0]	inpatient encounter

XML View

<Encounter xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-LegalStatus-Example" />
    <!--  **************extension start**************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus">
        <extension url="legalStatusContext">
            <valueCodeableConcept>
                <coding>
                    <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-LegalStatusContext" />
                    <code value="admission" />
                    <display value="Admission" />
                </coding>
            </valueCodeableConcept>
        </extension>
        <extension url="legalStatusClassification">
            <valueCodeableConcept>
                <coding>
                    <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-LegalStatusClassificationWales" />
                    <code value="02" />
                    <display value="Formally detained under Mental Health Act Section 2 (Admission for assessment)" />
                </coding>
            </valueCodeableConcept>
        </extension>
    </extension>
    <!--  **************extension end**************  -->
    <status value="finished" />
    <class>
        <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode" />
        <code value="IMP" />
        <display value="inpatient encounter" />
    </class>
</Encounter>

JSON View

{
    "resourceType": "Encounter",
    "id": "UKCore-Extension-LegalStatus-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus",
            "extension":  [
                {
                    "url": "legalStatusContext",
                    "valueCodeableConcept": {
                        "coding":  [
                            {
                                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-LegalStatusContext",
                                "code": "admission",
                                "display": "Admission"
                            }
                        ]
                    }
                },
                {
                    "url": "legalStatusClassification",
                    "valueCodeableConcept": {
                        "coding":  [
                            {
                                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-LegalStatusClassificationWales",
                                "code": "02",
                                "display": "Formally detained under Mental Health Act Section 2 (Admission for assessment)"
                            }
                        ]
                    }
                }
            ]
        }
    ],
    "status": "finished",
    "class": {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
        "code": "IMP",
        "display": "inpatient encounter"
    }
}

An example to illustrate the date when a prescription was last issued

Table View

MedicationStatement.id[0]	UKCore-Extension-MedicationStatementLastIssueDate-Example
MedicationStatement.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationStatementLastIssueDate
MedicationStatement.extension[0].value[0]	2017-02-24
MedicationStatement.status[0]	active
MedicationStatement.medication[0].coding[0].system[0]	https://dmd.nhs.uk
MedicationStatement.medication[0].coding[0].code[0]	39732311000001104
MedicationStatement.medication[0].coding[0].display[0]	Amoxicillin 250mg capsules
MedicationStatement.subject[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example

XML View

<MedicationStatement xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-MedicationStatementLastIssueDate-Example" />
    <!--  **************extension start**************  -->
    <!-- MedicationStatement Last Issue Date extension details -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationStatementLastIssueDate">
        <valueDateTime value="2017-02-24" />
    </extension>
    <!--  **************extension end**************  -->
    <status value="active" />
    <medicationCodeableConcept>
        <coding>
            <system value="https://dmd.nhs.uk" />
            <code value="39732311000001104" />
            <display value="Amoxicillin 250mg capsules" />
        </coding>
    </medicationCodeableConcept>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
</MedicationStatement>

JSON View

{
    "resourceType": "MedicationStatement",
    "id": "UKCore-Extension-MedicationStatementLastIssueDate-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationStatementLastIssueDate",
            "valueDateTime": "2017-02-24"
        }
    ],
    "status": "active",
    "medicationCodeableConcept": {
        "coding":  [
            {
                "system": "https://dmd.nhs.uk",
                "code": "39732311000001104",
                "display": "Amoxicillin 250mg capsules"
            }
        ]
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    }
}

An example to illustrate a warning being provided in a list resource

Table View

List.id[0]	UKCore-Extension-ListWarningCode-Example
List.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ListWarningCode
List.extension[0].value[0]	data-in-transit
List.status[0]	current
List.mode[0]	working
List.code[0].coding[0].system[0]	http://snomed.info/sct
List.code[0].coding[0].code[0]	826501000000100
List.code[0].coding[0].display[0]	Miscellaneous record
List.subject[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example
List.date[0]	2021-12-10T13:00:00+00:00

XML View

<List xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-ListWarningCode-Example" />
    <!--   **************extension start**************   -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ListWarningCode">
        <valueCode value="data-in-transit" />
    </extension>
    <!--   **************extension end**************   -->
    <status value="current" />
    <mode value="working" />
    <code>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="826501000000100" />
            <display value="Miscellaneous record" />
        </coding>
    </code>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <date value="2021-12-10T13:00:00+00:00" />
</List>

JSON View

{
    "resourceType": "List",
    "id": "UKCore-Extension-ListWarningCode-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ListWarningCode",
            "valueCode": "data-in-transit"
        }
    ],
    "status": "current",
    "mode": "working",
    "code": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "826501000000100",
                "display": "Miscellaneous record"
            }
        ]
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "date": "2021-12-10T13:00:00+00:00"
}

An example to illustrate the extension which shows an organisation's main location

Table View

Organization.id[0]	UKCore-Extension-MainLocation-Example
Organization.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation
Organization.extension[0].value[0].reference[0]	Location/UKCore-Location-HospitalSJUH-Example
Organization.extension[0].value[0].type[0]	Location
Organization.extension[0].value[0].identifier[0].use[0]	official
Organization.extension[0].value[0].identifier[0].system[0]	https://fhir.nhs.uk/Id/ods-site-code
Organization.extension[0].value[0].identifier[0].value[0]	RR813
Organization.identifier[0].use[0]	official
Organization.identifier[0].system[0]	https://fhir.nhs.uk/Id/ods-organization-code
Organization.identifier[0].value[0]	RR8
Organization.name[0]	LEEDS TEACHING HOSPITALS NHS TRUST

XML View

<Organization xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-MainLocation-Example" />
    <!--  **************extension start**************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation">
        <valueReference>
            <reference value="Location/UKCore-Location-HospitalSJUH-Example" />
            <type value="Location" />
            <identifier>
                <use value="official" />
                <system value="https://fhir.nhs.uk/Id/ods-site-code" />
                <value value="RR813" />
            </identifier>
        </valueReference>
    </extension>
    <!--  *************extension end ***************** -->
    <identifier>
        <use value="official" />
        <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
        <value value="RR8" />
    </identifier>
    <name value="LEEDS TEACHING HOSPITALS NHS TRUST" />
</Organization>

JSON View

{
    "resourceType": "Organization",
    "id": "UKCore-Extension-MainLocation-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation",
            "valueReference": {
                "reference": "Location/UKCore-Location-HospitalSJUH-Example",
                "type": "Location",
                "identifier": {
                    "use": "official",
                    "system": "https://fhir.nhs.uk/Id/ods-site-code",
                    "value": "RR813"
                }
            }
        }
    ],
    "identifier":  [
        {
            "use": "official",
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "RR8"
        }
    ],
    "name": "LEEDS TEACHING HOSPITALS NHS TRUST"
}

An example to illustrate the type of organisation or setting responsible for authorising and issuing a medication, but not the organisation or setting delivering the patient care

Table View

MedicationStatement.id[0]	UKCore-Extension-MedicationPrescribingOrganizationType-Example
MedicationStatement.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationPrescribingOrganizationType
MedicationStatement.extension[0].value[0].coding[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-MedicationPrescribingOrganizationType
MedicationStatement.extension[0].value[0].coding[0].code[0]	prescribed-at-gp-practice
MedicationStatement.extension[0].value[0].coding[0].display[0]	Prescribed at GP practice
MedicationStatement.status[0]	active
MedicationStatement.medication[0].coding[0].system[0]	https://dmd.nhs.uk
MedicationStatement.medication[0].coding[0].code[0]	39732311000001104
MedicationStatement.medication[0].coding[0].display[0]	Amoxicillin 250mg capsules
MedicationStatement.subject[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example

XML View

<MedicationStatement xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-MedicationPrescribingOrganizationType-Example" />
    <!--  **************extension start**************  -->
    <!-- Medication Prescribing Organization extension details -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationPrescribingOrganizationType">
        <valueCodeableConcept>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-MedicationPrescribingOrganizationType" />
                <code value="prescribed-at-gp-practice" />
                <display value="Prescribed at GP practice" />
            </coding>
        </valueCodeableConcept>
    </extension>
    <!--  **************extension end**************  -->
    <status value="active" />
    <medicationCodeableConcept>
        <coding>
            <system value="https://dmd.nhs.uk" />
            <code value="39732311000001104" />
            <display value="Amoxicillin 250mg capsules" />
        </coding>
    </medicationCodeableConcept>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
</MedicationStatement>

JSON View

{
    "resourceType": "MedicationStatement",
    "id": "UKCore-Extension-MedicationPrescribingOrganizationType-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationPrescribingOrganizationType",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-MedicationPrescribingOrganizationType",
                        "code": "prescribed-at-gp-practice",
                        "display": "Prescribed at GP practice"
                    }
                ]
            }
        }
    ],
    "status": "active",
    "medicationCodeableConcept": {
        "coding":  [
            {
                "system": "https://dmd.nhs.uk",
                "code": "39732311000001104",
                "display": "Amoxicillin 250mg capsules"
            }
        ]
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    }
}

An example to illustrate the use of a trade family or brand

Table View

Medication.id[0]	UKCore-Extension-MedicationTradeFamily-Example
Medication.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily
Medication.extension[0].value[0].coding[0].system[0]	http://snomed.info/sct
Medication.extension[0].value[0].coding[0].code[0]	9298001000001101
Medication.extension[0].value[0].coding[0].display[0]	Panadol Extra
Medication.code[0].coding[0].system[0]	https://dmd.nhs.uk
Medication.code[0].coding[0].code[0]	18677911000001109
Medication.code[0].coding[0].display[0]	Panadol Extra Advance 500mg/65mg tablets (Haleon UK Ltd)

XML View

<Medication xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-MedicationTradeFamily-Example" />
    <!--  **************extension start**************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily">
        <valueCodeableConcept>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="9298001000001101" />
                <display value="Panadol Extra" />
            </coding>
        </valueCodeableConcept>
    </extension>
    <!--  **************extension end**************  -->
    <code>
        <coding>
            <system value="https://dmd.nhs.uk" />
            <code value="18677911000001109" />
            <display value="Panadol Extra Advance 500mg/65mg tablets (Haleon UK Ltd)" />
        </coding>
    </code>
</Medication>

JSON View

{
    "resourceType": "Medication",
    "id": "UKCore-Extension-MedicationTradeFamily-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "9298001000001101",
                        "display": "Panadol Extra"
                    }
                ]
            }
        }
    ],
    "code": {
        "coding":  [
            {
                "system": "https://dmd.nhs.uk",
                "code": "18677911000001109",
                "display": "Panadol Extra Advance 500mg/65mg tablets (Haleon UK Ltd)"
            }
        ]
    }
}

An example of the extension which states the reason a patient does not have a NHS number

Table View

Patient.id[0]	UKCore-Extension-NHSNumberUnavailableReason-Example
Patient.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberUnavailableReason
Patient.extension[0].value[0].coding[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberUnavailableReason
Patient.extension[0].value[0].coding[0].code[0]	overseas-patient
Patient.extension[0].value[0].coding[0].display[0]	Overseas patient
Patient.name[0].use[0]	official
Patient.name[0].family[0]	BAPTISTE
Patient.name[0].given[0]	Jean

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-NHSNumberUnavailableReason-Example" />
    <!--  **************extension start**************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberUnavailableReason">
        <valueCodeableConcept>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberUnavailableReason" />
                <code value="overseas-patient" />
                <display value="Overseas patient" />
            </coding>
        </valueCodeableConcept>
    </extension>
    <!--  **************extension end**************  -->
    <name>
        <use value="official" />
        <family value="BAPTISTE" />
        <given value="Jean" />
    </name>
</Patient>

JSON View

{
    "resourceType": "Patient",
    "id": "UKCore-Extension-NHSNumberUnavailableReason-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberUnavailableReason",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberUnavailableReason",
                        "code": "overseas-patient",
                        "display": "Overseas patient"
                    }
                ]
            }
        }
    ],
    "name":  [
        {
            "use": "official",
            "family": "BAPTISTE",
            "given":  [
                "Jean"
            ]
        }
    ]
}

An example of the extension which states the patient's NHS number verification status

Table View

Patient.id[0]	UKCore-Extension-NHSNumberVerificationStatus-Example
Patient.identifier[0].extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus
Patient.identifier[0].extension[0].value[0].coding[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland
Patient.identifier[0].extension[0].value[0].coding[0].code[0]	01
Patient.identifier[0].extension[0].value[0].coding[0].display[0]	Number present and verified

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-NHSNumberVerificationStatus-Example" />
    <identifier>
        <!--  **************extension start**************  -->
        <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus">
            <valueCodeableConcept>
                <coding>
                    <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland" />
                    <code value="01" />
                    <display value="Number present and verified" />
                </coding>
            </valueCodeableConcept>
        </extension>
        <!--  **************extension end**************  -->
    </identifier>
</Patient>

JSON View

{
    "resourceType": "Patient",
    "id": "UKCore-Extension-NHSNumberVerificationStatus-Example",
    "identifier":  [
        {
            "extension":  [
                {
                    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus",
                    "valueCodeableConcept": {
                        "coding":  [
                            {
                                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland",
                                "code": "01",
                                "display": "Number present and verified"
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

An example to illustrate sending a note with a diagnostic report

Table View

DiagnosticReport.id[0]	UKCore-Extension-Note-Example
DiagnosticReport.extension[0].url[0]	http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note
DiagnosticReport.extension[0].value[0].author[0].reference[0]	Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example
DiagnosticReport.extension[0].value[0].time[0]	2023-05-10T10:39:12+00:00
DiagnosticReport.extension[0].value[0].text[0]	Inconclusive finding of staphylococcus, no evidence of bacteremia.
DiagnosticReport.identifier[0].system[0]	https://tools.ietf.org/html/rfc4122
DiagnosticReport.identifier[0].value[0]	957d702f-7e9e-43c2-b783-978f2c164b3c
DiagnosticReport.status[0]	final
DiagnosticReport.code[0].coding[0].system[0]	http://snomed.info/sct
DiagnosticReport.code[0].coding[0].code[0]	104177005
DiagnosticReport.code[0].coding[0].display[0]	Blood culture for bacteria, including anaerobic screen
DiagnosticReport.subject[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example
DiagnosticReport.performer[0].reference[0]	Organization/UKCore-Organization-LeedsTeachingHospital-Example
DiagnosticReport.performer[0].display[0]	LEEDS TEACHING HOSPITALS NHS TRUST

XML View

<DiagnosticReport xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-Note-Example" />
    <extension url="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note">
        <valueAnnotation>
            <authorReference>
                <reference value="Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example" />
            </authorReference>
            <time value="2023-05-10T10:39:12+00:00" />
            <text value="Inconclusive finding of staphylococcus, no evidence of bacteremia." />
        </valueAnnotation>
    </extension>
    <identifier>
        <system value="https://tools.ietf.org/html/rfc4122" />
        <value value="957d702f-7e9e-43c2-b783-978f2c164b3c" />
    </identifier>
    <status value="final" />
    <code>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="104177005" />
            <display value="Blood culture for bacteria, including anaerobic screen" />
        </coding>
    </code>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <performer>
        <reference value="Organization/UKCore-Organization-LeedsTeachingHospital-Example" />
        <display value="LEEDS TEACHING HOSPITALS NHS TRUST" />
    </performer>
</DiagnosticReport>

JSON View

{
    "resourceType": "DiagnosticReport",
    "id": "UKCore-Extension-Note-Example",
    "extension":  [
        {
            "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note",
            "valueAnnotation": {
                "authorReference": {
                    "reference": "Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example"
                },
                "time": "2023-05-10T10:39:12+00:00",
                "text": "Inconclusive finding of staphylococcus, no evidence of bacteremia."
            }
        }
    ],
    "identifier":  [
        {
            "system": "https://tools.ietf.org/html/rfc4122",
            "value": "957d702f-7e9e-43c2-b783-978f2c164b3c"
        }
    ],
    "status": "final",
    "code": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "104177005",
                "display": "Blood culture for bacteria, including anaerobic screen"
            }
        ]
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "performer":  [
        {
            "reference": "Organization/UKCore-Organization-LeedsTeachingHospital-Example",
            "display": "LEEDS TEACHING HOSPITALS NHS TRUST"
        }
    ]
}

An example to illustrate the date range that this organisation should be considered available using the core-defined extension

Table View

Organization.id[0]	UKCore-Extension-Period-Example
Organization.extension[0].url[0]	http://hl7.org/fhir/StructureDefinition/organization-period
Organization.extension[0].value[0].start[0]	2017-01-01T00:00:00.000Z
Organization.identifier[0].use[0]	official
Organization.identifier[0].system[0]	https://fhir.nhs.uk/Id/ods-organization-code
Organization.identifier[0].value[0]	RR8
Organization.name[0]	LEEDS TEACHING HOSPITALS NHS TRUST

XML View

<Organization xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-Period-Example" />
    <!--  **************extension start**************  -->
    <extension url="http://hl7.org/fhir/StructureDefinition/organization-period">
        <valuePeriod>
            <start value="2017-01-01T00:00:00.000Z" />
        </valuePeriod>
    </extension>
    <!--  *************extension end ***************** -->
    <identifier>
        <use value="official" />
        <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
        <value value="RR8" />
    </identifier>
    <name value="LEEDS TEACHING HOSPITALS NHS TRUST" />
</Organization>

JSON View

{
    "resourceType": "Organization",
    "id": "UKCore-Extension-Period-Example",
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/organization-period",
            "valuePeriod": {
                "start": "2017-01-01T00:00:00.000Z"
            }
        }
    ],
    "identifier":  [
        {
            "use": "official",
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "RR8"
        }
    ],
    "name": "LEEDS TEACHING HOSPITALS NHS TRUST"
}

An example to illustrate the extension to indicate other contact system(s) for a patient Richard Smith

Table View

Patient.id[0]	UKCore-Extension-OtherContactSystem-Example
Patient.telecom[0].system[0]	other
Patient.telecom[0].system[0].extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Patient.telecom[0].system[0].extension[0].value[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-OtherContactSystem
Patient.telecom[0].system[0].extension[0].value[0].code[0]	textphone
Patient.telecom[0].system[0].extension[0].value[0].display[0]	Minicom (Textphone)
Patient.telecom[0].value[0]	+4413513341777
Patient.telecom[0].use[0]	home

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-OtherContactSystem-Example" />
    <telecom>
        <system value="other">
            <!--  **************extension start**************  -->
            <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem">
                <valueCoding>
                    <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-OtherContactSystem" />
                    <code value="textphone" />
                    <display value="Minicom (Textphone)" />
                </valueCoding>
            </extension>
            <!--  *************extension end ***************** -->
        </system>
        <value value="+4413513341777" />
        <use value="home" />
    </telecom>
</Patient>

JSON View

{
    "resourceType": "Patient",
    "id": "UKCore-Extension-OtherContactSystem-Example",
    "telecom":  [
        {
            "system": "other",
            "_system": {
                "extension":  [
                    {
                        "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem",
                        "valueCoding": {
                            "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-OtherContactSystem",
                            "code": "textphone",
                            "display": "Minicom (Textphone)"
                        }
                    }
                ]
            },
            "value": "+4413513341777",
            "use": "home"
        }
    ]
}

An example to illustrate the extension which is used to indicate the outcome of an outpatient attendance

Table View

Encounter.id[0]	UKCore-Extension-OutcomeofAttendance-Example
Encounter.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OutcomeofAttendance
Encounter.extension[0].value[0].coding[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-OutcomeOfAttendanceEngland
Encounter.extension[0].value[0].coding[0].code[0]	1
Encounter.extension[0].value[0].coding[0].display[0]	Discharged from consultant's care (last attendance)
Encounter.status[0]	finished
Encounter.class[0].system[0]	http://terminology.hl7.org/CodeSystem/v3-ActCode
Encounter.class[0].code[0]	IMP
Encounter.class[0].display[0]	inpatient encounter

XML View

<Encounter xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-OutcomeofAttendance-Example" />
    <!--   **************extension start**************   -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OutcomeofAttendance">
        <valueCodeableConcept>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-OutcomeOfAttendanceEngland" />
                <code value="1" />
                <display value="Discharged from consultant&#39;s care (last attendance)" />
            </coding>
        </valueCodeableConcept>
    </extension>
    <!--   **************extension end**************   -->
    <status value="finished" />
    <class>
        <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode" />
        <code value="IMP" />
        <display value="inpatient encounter" />
    </class>
</Encounter>

JSON View

{
    "resourceType": "Encounter",
    "id": "UKCore-Extension-OutcomeofAttendance-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OutcomeofAttendance",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-OutcomeOfAttendanceEngland",
                        "code": "1",
                        "display": "Discharged from consultant's care (last attendance)"
                    }
                ]
            }
        }
    ],
    "status": "finished",
    "class": {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
        "code": "IMP",
        "display": "inpatient encounter"
    }
}

An example to illustrate the extension for a vaccination procedure where the parent of the patient is present

Table View

Immunization.id[0]	UKCore-Extension-ParentPresent-Example
Immunization.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ParentPresent
Immunization.extension[0].value[0]	True
Immunization.status[0]	completed
Immunization.vaccineCode[0].coding[0].system[0]	https://dmd.nhs.uk
Immunization.vaccineCode[0].coding[0].code[0]	10245211000001108
Immunization.vaccineCode[0].coding[0].display[0]	Pneumococcal polysaccharide conjugated vaccine (adsorbed) suspension for injection 0.5ml pre-filled syringes
Immunization.patient[0].reference[0]	Patient/UKCore-Patient-BabyPatient-Example
Immunization.occurrence[0]	2021-07-20

XML View

<Immunization xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-ParentPresent-Example" />
    <!--  **************extension start**************  -->
    <!-- This describes whether a parent was present at the immunisation of a child. -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ParentPresent">
        <valueBoolean value="true" />
    </extension>
    <!--  **************extension end**************  -->
    <status value="completed" />
    <vaccineCode>
        <coding>
            <system value="https://dmd.nhs.uk" />
            <code value="10245211000001108" />
            <display value="Pneumococcal polysaccharide conjugated vaccine (adsorbed) suspension for injection 0.5ml pre-filled syringes" />
        </coding>
    </vaccineCode>
    <patient>
        <reference value="Patient/UKCore-Patient-BabyPatient-Example" />
    </patient>
    <occurrenceDateTime value="2021-07-20" />
</Immunization>

JSON View

{
    "resourceType": "Immunization",
    "id": "UKCore-Extension-ParentPresent-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ParentPresent",
            "valueBoolean": true
        }
    ],
    "status": "completed",
    "vaccineCode": {
        "coding":  [
            {
                "system": "https://dmd.nhs.uk",
                "code": "10245211000001108",
                "display": "Pneumococcal polysaccharide conjugated vaccine (adsorbed) suspension for injection 0.5ml pre-filled syringes"
            }
        ]
    },
    "patient": {
        "reference": "Patient/UKCore-Patient-BabyPatient-Example"
    },
    "occurrenceDateTime": "2021-07-20"
}

An example to illustrate sending the participant involved in recording the activities relating to this family member history

Table View

FamilyMemberHistory.id[0]	UKCore-Extension-Participant-Example
FamilyMemberHistory.extension[0].extension[0].url[0]	function
FamilyMemberHistory.extension[0].extension[0].value[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/provenance-participant-type
FamilyMemberHistory.extension[0].extension[0].value[0].coding[0].code[0]	enterer
FamilyMemberHistory.extension[0].extension[0].value[0].coding[0].display[0]	Enterer
FamilyMemberHistory.extension[0].extension[1].url[0]	actor
FamilyMemberHistory.extension[0].extension[1].value[0].reference[0]	Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example
FamilyMemberHistory.extension[0].url[0]	http://hl7.org/fhir/5.0/StructureDefinition/extension-FamilyMemberHistory.participant
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-10
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]	160308005
FamilyMemberHistory.condition[0].code[0].coding[0].display[0]	Family history: Gout
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

XML View

<FamilyMemberHistory xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-Participant-Example" />
    <extension url="http://hl7.org/fhir/5.0/StructureDefinition/extension-FamilyMemberHistory.participant">
        <extension url="function">
            <valueCodeableConcept>
                <coding>
                    <system value="http://terminology.hl7.org/CodeSystem/provenance-participant-type" />
                    <code value="enterer" />
                    <display value="Enterer" />
                </coding>
            </valueCodeableConcept>
        </extension>
        <extension url="actor">
            <valueReference>
                <reference value="Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example" />
            </valueReference>
        </extension>
    </extension>
    <status value="partial" />
    <patient>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
        <display value="Richard Smith" />
    </patient>
    <date value="2023-05-10" />
    <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="160308005" />
                <display value="Family history: Gout" />
            </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-Participant-Example",
    "extension":  [
        {
            "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-FamilyMemberHistory.participant",
            "extension":  [
                {
                    "url": "function",
                    "valueCodeableConcept": {
                        "coding":  [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                                "code": "enterer",
                                "display": "Enterer"
                            }
                        ]
                    }
                },
                {
                    "url": "actor",
                    "valueReference": {
                        "reference": "Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example"
                    }
                }
            ]
        }
    ],
    "status": "partial",
    "patient": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example",
        "display": "Richard Smith"
    },
    "date": "2023-05-10",
    "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": "160308005",
                        "display": "Family history: Gout"
                    }
                ]
            },
            "onsetAge": {
                "value": 64,
                "unit": "year",
                "system": "http://unitsofmeasure.org",
                "code": "a"
            }
        }
    ]
}

An example to illustrate whether a pharmacist verified a medication

Table View

MedicationStatement.id[0]	UKCore-Extension-PharmacistVerifiedIndicator-Example
MedicationStatement.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PharmacistVerifiedIndicator
MedicationStatement.extension[0].value[0]	True
MedicationStatement.status[0]	active
MedicationStatement.medication[0].coding[0].system[0]	https://dmd.nhs.uk
MedicationStatement.medication[0].coding[0].code[0]	39732311000001104
MedicationStatement.medication[0].coding[0].display[0]	Amoxicillin 250mg capsules
MedicationStatement.subject[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example

XML View

<MedicationStatement xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-PharmacistVerifiedIndicator-Example" />
    <!--  **************extension start**************  -->
    <!-- Pharmacist Verified Indicator extension details -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PharmacistVerifiedIndicator">
        <valueBoolean value="true" />
    </extension>
    <!--  **************extension end**************  -->
    <status value="active" />
    <medicationCodeableConcept>
        <coding>
            <system value="https://dmd.nhs.uk" />
            <code value="39732311000001104" />
            <display value="Amoxicillin 250mg capsules" />
        </coding>
    </medicationCodeableConcept>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
</MedicationStatement>

JSON View

{
    "resourceType": "MedicationStatement",
    "id": "UKCore-Extension-PharmacistVerifiedIndicator-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PharmacistVerifiedIndicator",
            "valueBoolean": true
        }
    ],
    "status": "active",
    "medicationCodeableConcept": {
        "coding":  [
            {
                "system": "https://dmd.nhs.uk",
                "code": "39732311000001104",
                "display": "Amoxicillin 250mg capsules"
            }
        ]
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    }
}

An example to illustrate sending a priority reason for an urgent ServiceRequest, using a SNOMED CT concept

Table View

The resource cannot be rendered.

XML View

<ServiceRequest xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-PriorityReason-Example" />
    <status value="active" />
    <intent value="order" />
    <priority value="urgent">
        <!--  ***************extension start***************  -->
        <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason">
            <valueCodeableConcept>
                <coding>
                    <system value="http://snomed.info/sct" />
                    <code value="1321851000000109" />
                    <display value="Provision of advice, assessment or treatment delayed due to COVID-19 pandemic" />
                </coding>
            </valueCodeableConcept>
        </extension>
        <!--  **************extension end ******************  -->
    </priority>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <requester>
        <reference value="Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example" />
    </requester>
</ServiceRequest>

JSON View

{
    "resourceType": "ServiceRequest",
    "id": "UKCore-Extension-PriorityReason-Example",
    "priority": "urgent",
    "_priority": {
        "extension":  [
            {
                "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason",
                "valueCodeableConcept": {
                    "coding":  [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "1321851000000109",
                            "display": "Provision of advice, assessment or treatment delayed due to COVID-19 pandemic"
                        }
                    ]
                }
            }
        ]
    },
    "status": "active",
    "intent": "order",
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "requester": {
        "reference": "Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example"
    }
}

An example to illustrate sending a priority reason for an urgent ServiceRequest, using plain text

Table View

The resource cannot be rendered.

XML View

<ServiceRequest xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-PriorityReason-SendingAsText-Example" />
    <status value="active" />
    <intent value="order" />
    <priority value="urgent">
        <!--  ***************extension start***************  -->
        <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason">
            <valueCodeableConcept>
                <text value="Original assessment was delayed due to COVID-19 pandemic" />
            </valueCodeableConcept>
        </extension>
        <!--  **************extension end ******************  -->
    </priority>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <requester>
        <reference value="Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example" />
    </requester>
</ServiceRequest>

JSON View

{
    "resourceType": "ServiceRequest",
    "id": "UKCore-Extension-PriorityReason-SendingAsText-Example",
    "priority": "urgent",
    "_priority": {
        "extension":  [
            {
                "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason",
                "valueCodeableConcept": {
                    "text": "Original assessment was delayed due to COVID-19 pandemic"
                }
            }
        ]
    },
    "status": "active",
    "intent": "order",
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "requester": {
        "reference": "Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example"
    }
}

An example to illustrate sending the setting a vital signs observation was recorded in

Table View

The resource cannot be rendered.

XML View

<Observation xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-RecordingSetting-Example" />
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-RcordingSetting">
        <valueCode value="residential" />
    </extension>
    <status value="final" />
    <category>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/observation-category" />
            <code value="vital-signs" />
            <display value="Vital Signs" />
        </coding>
    </category>
    <code>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="75367002" />
            <display value="Blood pressure" />
        </coding>
        <coding>
            <system value="http://loinc.org" />
            <code value="85354-9" />
            <display value="Blood pressure panel with all children optional" />
        </coding>
        <text value="Blood pressure" />
    </code>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <effectiveDateTime value="2023-09-10" />
    <performer>
        <reference value="Organization/UKCore-Organization-LeedsTeachingHospital-Example" />
    </performer>
    <component>
        <code>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="72313002" />
                <display value="Systolic arterial pressure" />
            </coding>
            <coding>
                <system value="http://loinc.org" />
                <code value="8480-6" />
                <display value="Systolic blood pressure" />
            </coding>
            <text value="Systolic blood pressure" />
        </code>
        <valueQuantity>
            <value value="108" />
            <unit value="millimeter of mercury" />
            <system value="http://unitsofmeasure.org" />
            <code value="mm[Hg]" />
        </valueQuantity>
    </component>
    <component>
        <code>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="1091811000000102" />
                <display value="Diastolic arterial pressure" />
            </coding>
            <coding>
                <system value="http://loinc.org" />
                <code value="8462-4" />
                <display value="Diastolic blood pressure" />
            </coding>
            <text value="Diastolic blood pressure" />
        </code>
        <valueQuantity>
            <value value="82" />
            <unit value="millimeter of mercury" />
            <system value="http://unitsofmeasure.org" />
            <code value="mm[Hg]" />
        </valueQuantity>
    </component>
</Observation>

JSON View

{
    "resourceType": "Observation",
    "id": "UKCore-Extension-RecordingSetting-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-RcordingSetting",
            "valueCode": "residential"
        }
    ],
    "status": "final",
    "category":  [
        {
            "coding":  [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                    "code": "vital-signs",
                    "display": "Vital Signs"
                }
            ]
        }
    ],
    "code": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "75367002",
                "display": "Blood pressure"
            },
            {
                "system": "http://loinc.org",
                "code": "85354-9",
                "display": "Blood pressure panel with all children optional"
            }
        ],
        "text": "Blood pressure"
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "effectiveDateTime": "2023-09-10",
    "performer":  [
        {
            "reference": "Organization/UKCore-Organization-LeedsTeachingHospital-Example"
        }
    ],
    "component":  [
        {
            "code": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "72313002",
                        "display": "Systolic arterial pressure"
                    },
                    {
                        "system": "http://loinc.org",
                        "code": "8480-6",
                        "display": "Systolic blood pressure"
                    }
                ],
                "text": "Systolic blood pressure"
            },
            "valueQuantity": {
                "value": 108,
                "unit": "millimeter of mercury",
                "system": "http://unitsofmeasure.org",
                "code": "mm[Hg]"
            }
        },
        {
            "code": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "1091811000000102",
                        "display": "Diastolic arterial pressure"
                    },
                    {
                        "system": "http://loinc.org",
                        "code": "8462-4",
                        "display": "Diastolic blood pressure"
                    }
                ],
                "text": "Diastolic blood pressure"
            },
            "valueQuantity": {
                "value": 82,
                "unit": "millimeter of mercury",
                "system": "http://unitsofmeasure.org",
                "code": "mm[Hg]"
            }
        }
    ]
}

An example to illustrate the specific repeat information of a medication item

Table View

MedicationRequest.id[0]	UKCore-Extension-RepeatInformation-Example
MedicationRequest.extension[0].extension[0].url[0]	numberOfPrescriptionsIssued
MedicationRequest.extension[0].extension[0].value[0]	1
MedicationRequest.extension[0].extension[1].url[0]	authorisationExpiryDate
MedicationRequest.extension[0].extension[1].value[0]	2022-09-10T19:00:00.000Z
MedicationRequest.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationRepeatInformation
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.priority[0]	routine
MedicationRequest.medication[0].reference[0]	Medication/UKCore-Medication-TimoptolEyeDrops-Example
MedicationRequest.subject[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example
MedicationRequest.requester[0].reference[0]	Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example
MedicationRequest.recorder[0].reference[0]	Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example
MedicationRequest.courseOfTherapyType[0].coding[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-MedicationRequestCourseOfTherapy
MedicationRequest.courseOfTherapyType[0].coding[0].code[0]	continuous-repeating-dispensing
MedicationRequest.courseOfTherapyType[0].coding[0].display[0]	Continuous long term (repeat dispensing)
MedicationRequest.dosageInstruction[0].text[0]	1 drop in each affected eye twice daily, approximately 12 hours apart.
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]	362508001
MedicationRequest.dosageInstruction[0].site[0].coding[0].display[0]	Both eyes, entire
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.substitution[0].allowed[0]	True

XML View

<MedicationRequest xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-RepeatInformation-Example" />
    <!--  **************extension start**************  -->
    <!-- MedicationRepeatInformation extension details -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationRepeatInformation">
        <extension url="numberOfPrescriptionsIssued">
            <valueUnsignedInt value="1" />
        </extension>
        <extension url="authorisationExpiryDate">
            <valueDateTime value="2022-09-10T19:00:00.000Z" />
        </extension>
    </extension>
    <!--  **************extension end**************  -->
    <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>
    <priority value="routine" />
    <medicationReference>
        <reference value="Medication/UKCore-Medication-TimoptolEyeDrops-Example" />
    </medicationReference>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <requester>
        <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" />
    </requester>
    <recorder>
        <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" />
    </recorder>
    <courseOfTherapyType>
        <coding>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-MedicationRequestCourseOfTherapy" />
            <code value="continuous-repeating-dispensing" />
            <display value="Continuous long term (repeat dispensing)" />
        </coding>
    </courseOfTherapyType>
    <dosageInstruction>
        <text value="1 drop in each affected eye twice daily, approximately 12 hours apart." />
        <timing>
            <repeat>
                <frequency value="1" />
                <period value="12" />
                <periodUnit value="h" />
            </repeat>
        </timing>
        <site>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="362508001" />
                <display value="Both eyes, entire" />
            </coding>
        </site>
        <method>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="421984009" />
                <display value="Until finished" />
            </coding>
        </method>
    </dosageInstruction>
    <substitution>
        <allowedBoolean value="true" />
    </substitution>
</MedicationRequest>

JSON View

{
    "resourceType": "MedicationRequest",
    "id": "UKCore-Extension-RepeatInformation-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationRepeatInformation",
            "extension":  [
                {
                    "url": "numberOfPrescriptionsIssued",
                    "valueUnsignedInt": 1
                },
                {
                    "url": "authorisationExpiryDate",
                    "valueDateTime": "2022-09-10T19:00:00.000Z"
                }
            ]
        }
    ],
    "status": "completed",
    "intent": "order",
    "category":  [
        {
            "coding":  [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/medicationrequest-category",
                    "code": "outpatient",
                    "display": "Outpatient"
                }
            ]
        }
    ],
    "priority": "routine",
    "medicationReference": {
        "reference": "Medication/UKCore-Medication-TimoptolEyeDrops-Example"
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "requester": {
        "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example"
    },
    "recorder": {
        "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example"
    },
    "courseOfTherapyType": {
        "coding":  [
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-MedicationRequestCourseOfTherapy",
                "code": "continuous-repeating-dispensing",
                "display": "Continuous long term (repeat dispensing)"
            }
        ]
    },
    "dosageInstruction":  [
        {
            "text": "1 drop in each affected eye twice daily, approximately 12 hours apart.",
            "timing": {
                "repeat": {
                    "frequency": 1,
                    "period": 12,
                    "periodUnit": "h"
                }
            },
            "site": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "362508001",
                        "display": "Both eyes, entire"
                    }
                ]
            },
            "method": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "421984009",
                        "display": "Until finished"
                    }
                ]
            }
        }
    ],
    "substitution": {
        "allowedBoolean": true
    }
}

An example to illustrate the extension to show the patient's residential status

Table View

Patient.id[0]	UKCore-Extension-ResidentialStatus-Example
Patient.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus
Patient.extension[0].value[0].coding[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-ResidentialStatus
Patient.extension[0].value[0].coding[0].code[0]	H
Patient.extension[0].value[0].coding[0].display[0]	UK Resident

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-ResidentialStatus-Example" />
    <!--  **************extension start**************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus">
        <valueCodeableConcept>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-ResidentialStatus" />
                <code value="H" />
                <display value="UK Resident" />
            </coding>
        </valueCodeableConcept>
    </extension>
    <!--  **************extension end**************  -->
</Patient>

JSON View

{
    "resourceType": "Patient",
    "id": "UKCore-Extension-ResidentialStatus-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-ResidentialStatus",
                        "code": "H",
                        "display": "UK Resident"
                    }
                ]
            }
        }
    ]
}

An example to illustrate the HL7 extension ResponseRequest

Table View

MessageHeader.id[0]	UKCore-Extension-ResponseRequest-Example
MessageHeader.extension[0].url[0]	http://hl7.org/fhir/StructureDefinition/messageheader-response-request
MessageHeader.extension[0].value[0]	always
MessageHeader.event[0].system[0]	http://snomed.info/sct
MessageHeader.event[0].code[0]	306689006
MessageHeader.event[0].display[0]	Discharge to home
MessageHeader.destination[0].endpoint[0]	urn:nhs:addressing:asid:477121007825
MessageHeader.destination[0].receiver[0].identifier[0].system[0]	https://fhir.nhs.uk/Id/ods-organization-code
MessageHeader.destination[0].receiver[0].identifier[0].value[0]	RY6
MessageHeader.destination[0].receiver[0].display[0]	LEEDS COMMUNITY HEALTHCARE NHS TRUST
MessageHeader.sender[0].reference[0]	https://directory.spineservices.nhs.uk/Organization/X26
MessageHeader.source[0].endpoint[0]	NOROT003
MessageHeader.focus[0].reference[0]	Encounter/UKCore-Encounter-InpatientEncounter-Example

XML View

<MessageHeader xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-ResponseRequest-Example" />
    <!--  **************extension start**************  -->
    <extension url="http://hl7.org/fhir/StructureDefinition/messageheader-response-request">
        <valueCode value="always" />
    </extension>
    <!--  **************extension end**************  -->
    <eventCoding>
        <system value="http://snomed.info/sct" />
        <code value="306689006" />
        <display value="Discharge to home" />
    </eventCoding>
    <destination>
        <endpoint value="urn:nhs:addressing:asid:477121007825" />
        <receiver>
            <identifier>
                <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
                <value value="RY6" />
            </identifier>
            <display value="LEEDS COMMUNITY HEALTHCARE NHS TRUST" />
        </receiver>
    </destination>
    <sender>
        <reference value="https://directory.spineservices.nhs.uk/Organization/X26" />
    </sender>
    <source>
        <endpoint value="NOROT003" />
    </source>
    <focus>
        <reference value="Encounter/UKCore-Encounter-InpatientEncounter-Example" />
    </focus>
</MessageHeader>

JSON View

{
    "resourceType": "MessageHeader",
    "id": "UKCore-Extension-ResponseRequest-Example",
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/messageheader-response-request",
            "valueCode": "always"
        }
    ],
    "eventCoding": {
        "system": "http://snomed.info/sct",
        "code": "306689006",
        "display": "Discharge to home"
    },
    "destination":  [
        {
            "endpoint": "urn:nhs:addressing:asid:477121007825",
            "receiver": {
                "identifier": {
                    "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                    "value": "RY6"
                },
                "display": "LEEDS COMMUNITY HEALTHCARE NHS TRUST"
            }
        }
    ],
    "sender": {
        "reference": "https://directory.spineservices.nhs.uk/Organization/X26"
    },
    "source": {
        "endpoint": "NOROT003"
    },
    "focus":  [
        {
            "reference": "Encounter/UKCore-Encounter-InpatientEncounter-Example"
        }
    ]
}

An example to illustrate the use of the Sample Category extension.

Table View

Specimen.id[0]	UKCore-Extension-SampleCategory-Example
Specimen.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SampleCategory
Specimen.extension[0].value[0].coding[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-SampleCategory
Specimen.extension[0].value[0].coding[0].code[0]	germline
Specimen.extension[0].value[0].coding[0].display[0]	Germline
Specimen.status[0]	available
Specimen.type[0].coding[0].system[0]	http://snomed.info/sct
Specimen.type[0].coding[0].code[0]	4635002
Specimen.type[0].coding[0].display[0]	Arterial blood
Specimen.subject[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example
Specimen.receivedTime[0]	2022-11-25T11:10:00Z
Specimen.collection[0].collector[0].reference[0]	Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example
Specimen.collection[0].collected[0]	2022-11-25T16:00:00Z

XML View

<Specimen xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-SampleCategory-Example" />
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SampleCategory">
        <valueCodeableConcept>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-SampleCategory" />
                <code value="germline" />
                <display value="Germline" />
            </coding>
        </valueCodeableConcept>
    </extension>
    <status value="available" />
    <type>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="4635002" />
            <display value="Arterial blood" />
        </coding>
    </type>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <receivedTime value="2022-11-25T11:10:00Z" />
    <collection>
        <collector>
            <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" />
        </collector>
        <collectedDateTime value="2022-11-25T16:00:00Z" />
    </collection>
</Specimen>

JSON View

{
    "resourceType": "Specimen",
    "id": "UKCore-Extension-SampleCategory-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SampleCategory",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-SampleCategory",
                        "code": "germline",
                        "display": "Germline"
                    }
                ]
            }
        }
    ],
    "status": "available",
    "type": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "4635002",
                "display": "Arterial blood"
            }
        ]
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "receivedTime": "2022-11-25T11:10:00Z",
    "collection": {
        "collector": {
            "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example"
        },
        "collectedDateTime": "2022-11-25T16:00:00Z"
    }
}

An example to illustrate the source of service request extension associated with a service request

Table View

ServiceRequest.id[0]	UKCore-Extension-SourceOfServiceRequest-Example
ServiceRequest.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SourceOfServiceRequest
ServiceRequest.extension[0].value[0].coding[0].system[0]	http://snomed.info/sct
ServiceRequest.extension[0].value[0].coding[0].code[0]	108161000000109
ServiceRequest.extension[0].value[0].coding[0].display[0]	Referred by general practitioner
ServiceRequest.status[0]	active
ServiceRequest.intent[0]	order
ServiceRequest.subject[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example

XML View

<ServiceRequest xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-SourceOfServiceRequest-Example" />
    <!--  ***************extension start***************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SourceOfServiceRequest">
        <valueCodeableConcept>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="108161000000109" />
                <display value="Referred by general practitioner" />
            </coding>
        </valueCodeableConcept>
    </extension>
    <!--  **************extension end ******************  -->
    <status value="active" />
    <intent value="order" />
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
</ServiceRequest>

JSON View

{
    "resourceType": "ServiceRequest",
    "id": "UKCore-Extension-SourceOfServiceRequest-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SourceOfServiceRequest",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "108161000000109",
                        "display": "Referred by general practitioner"
                    }
                ]
            }
        }
    ],
    "status": "active",
    "intent": "order",
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    }
}

An example to illustrate the use of the HL7 core-defined Extension specimen-specialHandling

Table View

Specimen.id[0]	UKCore-Extension-SpecialHandling-Example
Specimen.status[0]	available
Specimen.type[0].coding[0].system[0]	http://snomed.info/sct
Specimen.type[0].coding[0].code[0]	431234000
Specimen.type[0].coding[0].display[0]	Specimen from fetus obtained by biopsy
Specimen.subject[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example
Specimen.receivedTime[0]	2023-04-23T17:02:00Z
Specimen.collection[0].extension[0].url[0]	http://hl7.org/fhir/StructureDefinition/specimen-specialHandling
Specimen.collection[0].extension[0].value[0].text[0]	Mother was infected with suspected viral haemorrhagic fever.
Specimen.collection[0].collector[0].reference[0]	Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example
Specimen.collection[0].collected[0]	2023-04-23T17:02:00Z
Specimen.collection[0].method[0].coding[0].system[0]	http://snomed.info/sct
Specimen.collection[0].method[0].coding[0].code[0]	129314006
Specimen.collection[0].method[0].coding[0].display[0]	Biopsy - action

XML View

<Specimen xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-SpecialHandling-Example" />
    <status value="available" />
    <type>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="431234000" />
            <display value="Specimen from fetus obtained by biopsy" />
        </coding>
    </type>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <receivedTime value="2023-04-23T17:02:00Z" />
    <collection>
        <!--  ***************extension start***************  -->
        <extension url="http://hl7.org/fhir/StructureDefinition/specimen-specialHandling">
            <valueCodeableConcept>
                <text value="Mother was infected with suspected viral haemorrhagic fever." />
            </valueCodeableConcept>
        </extension>
        <!--  **************extension end ******************  -->
        <collector>
            <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" />
        </collector>
        <collectedDateTime value="2023-04-23T17:02:00Z" />
        <method>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="129314006" />
                <display value="Biopsy - action" />
            </coding>
        </method>
    </collection>
</Specimen>

JSON View

{
    "resourceType": "Specimen",
    "id": "UKCore-Extension-SpecialHandling-Example",
    "status": "available",
    "type": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "431234000",
                "display": "Specimen from fetus obtained by biopsy"
            }
        ]
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "receivedTime": "2023-04-23T17:02:00Z",
    "collection": {
        "extension":  [
            {
                "url": "http://hl7.org/fhir/StructureDefinition/specimen-specialHandling",
                "valueCodeableConcept": {
                    "text": "Mother was infected with suspected viral haemorrhagic fever."
                }
            }
        ],
        "collector": {
            "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example"
        },
        "collectedDateTime": "2023-04-23T17:02:00Z",
        "method": {
            "coding":  [
                {
                    "system": "http://snomed.info/sct",
                    "code": "129314006",
                    "display": "Biopsy - action"
                }
            ]
        }
    }
}

An example to illustrate an observation triggered by another observation

Table View

The resource cannot be rendered.

XML View

<Observation xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-TriggeredBy-Example" />
    <extension url="http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy">
        <extension url="observation">
            <valueReference>
                <reference value="Observation/UKCore-Observation-DrugUse-Example" />
            </valueReference>
        </extension>
        <extension url="type">
            <valueCode value="reflex" />
        </extension>
        <extension url="reason">
            <valueString value="Patient admitted to recreational drug use." />
        </extension>
    </extension>
    <identifier>
        <system value="https://tools.ietf.org/html/rfc4122" />
        <value value="293a6418-9dcf-4d42-b97a-b119afd200ba" />
    </identifier>
    <status value="final" />
    <category>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/observation-category" />
            <code value="laboratory" />
            <display value="Laboratory" />
        </coding>
    </category>
    <code>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="1014801000000101" />
            <display value="Urine tricyclic drug screen" />
        </coding>
    </code>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <performer>
        <reference value="Organization/UKCore-Organization-LeedsTeachingHospital-Example" />
    </performer>
    <specimen>
        <reference value="Specimen/UKCore-Specimen-UrineSpecimen-Example" />
    </specimen>
</Observation>

JSON View

{
    "resourceType": "Observation",
    "id": "UKCore-Extension-TriggeredBy-Example",
    "extension":  [
        {
            "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy",
            "extension":  [
                {
                    "url": "observation",
                    "valueReference": {
                        "reference": "Observation/UKCore-Observation-DrugUse-Example"
                    }
                },
                {
                    "url": "type",
                    "valueCode": "reflex"
                },
                {
                    "url": "reason",
                    "valueString": "Patient admitted to recreational drug use."
                }
            ]
        }
    ],
    "identifier":  [
        {
            "system": "https://tools.ietf.org/html/rfc4122",
            "value": "293a6418-9dcf-4d42-b97a-b119afd200ba"
        }
    ],
    "status": "final",
    "category":  [
        {
            "coding":  [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                    "code": "laboratory",
                    "display": "Laboratory"
                }
            ]
        }
    ],
    "code": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "1014801000000101",
                "display": "Urine tricyclic drug screen"
            }
        ]
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "performer":  [
        {
            "reference": "Organization/UKCore-Organization-LeedsTeachingHospital-Example"
        }
    ],
    "specimen": {
        "reference": "Specimen/UKCore-Specimen-UrineSpecimen-Example"
    }
}

An example to illustrate the extension for a vaccination procedure

Table View

Immunization.id[0]	UKCore-Extension-VaccinationProcedure-Example
Immunization.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure
Immunization.extension[0].value[0].coding[0].system[0]	http://snomed.info/sct
Immunization.extension[0].value[0].coding[0].code[0]	73701000119109
Immunization.extension[0].value[0].coding[0].display[0]	Influenza vaccination given
Immunization.status[0]	completed
Immunization.vaccineCode[0].coding[0].system[0]	https://dmd.nhs.uk
Immunization.vaccineCode[0].coding[0].code[0]	11278411000001109
Immunization.vaccineCode[0].coding[0].display[0]	Influenza vaccine (split virion, inactivated) suspension for injection 0.5ml pre-filled syringes (Pfizer Ltd)
Immunization.patient[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example
Immunization.occurrence[0]	2013-01-10

XML View

<Immunization xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-VaccinationProcedure-Example" />
    <!--  **************extension start**************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure">
        <valueCodeableConcept>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="73701000119109" />
                <display value="Influenza vaccination given" />
            </coding>
        </valueCodeableConcept>
    </extension>
    <!--  **************extension end**************  -->
    <status value="completed" />
    <vaccineCode>
        <coding>
            <system value="https://dmd.nhs.uk" />
            <code value="11278411000001109" />
            <display value="Influenza vaccine (split virion, inactivated) suspension for injection 0.5ml pre-filled syringes (Pfizer Ltd)" />
        </coding>
    </vaccineCode>
    <patient>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </patient>
    <occurrenceDateTime value="2013-01-10" />
</Immunization>

JSON View

{
    "resourceType": "Immunization",
    "id": "UKCore-Extension-VaccinationProcedure-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "73701000119109",
                        "display": "Influenza vaccination given"
                    }
                ]
            }
        }
    ],
    "status": "completed",
    "vaccineCode": {
        "coding":  [
            {
                "system": "https://dmd.nhs.uk",
                "code": "11278411000001109",
                "display": "Influenza vaccine (split virion, inactivated) suspension for injection 0.5ml pre-filled syringes (Pfizer Ltd)"
            }
        ]
    },
    "patient": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "occurrenceDateTime": "2013-01-10"
}

An example to illustrate the extension for a vaccination procedure for COVID-19

Table View

Immunization.id[0]	UKCore-Extension-VaccinationProcedure-COVID-Example
Immunization.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure
Immunization.extension[0].value[0].coding[0].system[0]	http://snomed.info/sct
Immunization.extension[0].value[0].coding[0].code[0]	1324681000000101
Immunization.extension[0].value[0].coding[0].display[0]	Administration of first dose of severe acute respiratory syndrome coronavirus 2 vaccine (procedure)
Immunization.status[0]	completed
Immunization.vaccineCode[0].coding[0].system[0]	https://dmd.nhs.uk
Immunization.vaccineCode[0].coding[0].code[0]	39116211000001106
Immunization.vaccineCode[0].coding[0].display[0]	Generic COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials
Immunization.patient[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example
Immunization.occurrence[0]	2021-07-20

XML View

<Immunization xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-VaccinationProcedure-COVID-Example" />
    <!--  **************extension start**************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure">
        <valueCodeableConcept>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="1324681000000101" />
                <display value="Administration of first dose of severe acute respiratory syndrome coronavirus 2 vaccine (procedure)" />
            </coding>
        </valueCodeableConcept>
    </extension>
    <!--  **************extension end**************  -->
    <status value="completed" />
    <vaccineCode>
        <coding>
            <system value="https://dmd.nhs.uk" />
            <code value="39116211000001106" />
            <display value="Generic COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials" />
        </coding>
    </vaccineCode>
    <patient>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </patient>
    <occurrenceDateTime value="2021-07-20" />
</Immunization>

JSON View

{
    "resourceType": "Immunization",
    "id": "UKCore-Extension-VaccinationProcedure-COVID-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "1324681000000101",
                        "display": "Administration of first dose of severe acute respiratory syndrome coronavirus 2 vaccine (procedure)"
                    }
                ]
            }
        }
    ],
    "status": "completed",
    "vaccineCode": {
        "coding":  [
            {
                "system": "https://dmd.nhs.uk",
                "code": "39116211000001106",
                "display": "Generic COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials"
            }
        ]
    },
    "patient": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "occurrenceDateTime": "2021-07-20"
}