Examples

Extension Examples

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.text[0].status[0]additional
ServiceRequest.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate sending a reference to an additional contact with a service request</div>
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

Tree View

ServiceRequest

XML View

<ServiceRequest xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-AdditionalContact-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  ***************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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
Patient.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the use of an address key used with the address datatype</div>
Patient.address[0].extension[0].extension[0].url[0]type
Patient.address[0].extension[0].extension[0].value[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType
Patient.address[0].extension[0].extension[0].value[0].coding[0].code[0]PAF
Patient.address[0].extension[0].extension[0].value[0].coding[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

Tree View

Patient

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-AddressKey-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <address>
        <!--  **************extension start**************  -->
        <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey">
            <extension url="type">
                <valueCodeableConcept>
                    <coding>
                        <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType" />
                        <code value="PAF" />
                        <display value="Postcode Address File" />
                    </coding>
                </valueCodeableConcept>
            </extension>
            <extension url="value">
                <valueString value="LS10ABC" />
            </extension>
        </extension>
        <!--  *************extension end ***************** -->
        <line value="4 Sandmoor Drive" />
        <city value="LEEDS" />
        <postalCode value="LS17 7DF" />
    </address>
</Patient>

JSON View

{
    "resourceType": "Patient",
    "id": "UKCore-Extension-AddressKey-Example",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "address":  [
        {
            "extension":  [
                {
                    "extension":  [
                        {
                            "url": "type",
                            "valueCodeableConcept": {
                                "coding":  [
                                    {
                                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType",
                                        "code": "PAF",
                                        "display": "Postcode Address File"
                                    }
                                ]
                            }
                        },
                        {
                            "url": "value",
                            "valueString": "LS10ABC"
                        }
                    ],
                    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey"
                }
            ],
            "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.text[0].status[0]additional
Encounter.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the extension for an encounter to support the method by which an individual was admitted into hospital </div>
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

Tree View

Encounter

XML View

<Encounter xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-AdmissionMethod-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
AllergyIntolerance.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">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</div>
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

Tree View

AllergyIntolerance

XML View

<AllergyIntolerance xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-AllergyIntolEnd-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <clinicalStatus>
        <!--  **************extension start**************  -->
        <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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "clinicalStatus": {
        "extension":  [
            {
                "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."
                    }
                ],
                "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd"
            }
        ],
        "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.text[0].status[0]additional
FamilyMemberHistory.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate sending an associated encounter with family member history</div>
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

Tree View

FamilyMemberHistory

XML View

<FamilyMemberHistory xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-AssociatedEncounter-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  **************extension start**************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AssociatedEncounter">
        <valueReference>
            <reference value="Encounter/UKCore-Encounter-InpatientEncounter-Example" />
        </valueReference>
    </extension>
    <!--  **************extension end**************  -->
    <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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
Patient.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the registered place of birth of the patient using the core-defined extension</div>
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

Tree View

Patient

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-BirthPlace-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  **************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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
Patient.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the extension for a patient's birth sex</div>
Patient.extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex
Patient.extension[0].value[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/v3-AdministrativeGender
Patient.extension[0].value[0].coding[0].code[0]F
Patient.extension[0].value[0].coding[0].display[0]Female

Tree View

Patient

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-BirthSex-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  **************extension start**************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex">
        <valueCodeableConcept>
            <coding>
                <system value="http://terminology.hl7.org/CodeSystem/v3-AdministrativeGender" />
                <code value="F" />
                <display value="Female" />
            </coding>
        </valueCodeableConcept>
    </extension>
    <!--  **************extension end**************  -->
</Patient>

JSON View

{
    "resourceType": "Patient",
    "id": "UKCore-Extension-BirthSex-Example",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/v3-AdministrativeGender",
                        "code": "F",
                        "display": "Female"
                    }
                ]
            }
        }
    ]
}

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

Table View

Patient.id[0]UKCore-Extension-BirthTime-Example
Patient.text[0].status[0]additional
Patient.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the patient's birth time using the core-defined extension</div>
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

Tree View

Patient

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-BirthTime-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <birthDate>
        <!--  **************extension start**************  -->
        <extension url="http://hl7.org/fhir/StructureDefinition/patient-birthTime">
            <valueDateTime value="2002-03-11T15:39:00+00:00" />
        </extension>
        <!--  **************extension end**************  -->
    </birthDate>
</Patient>

JSON View

{
    "resourceType": "Patient",
    "id": "UKCore-Extension-BirthTime-Example",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "_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.text[0].status[0]additional
Specimen.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the use of the BodySiteReference extension</div>
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

Tree View

Specimen

XML View

<Specimen xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-BodySiteReference-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <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>
            <!--  **************extension start**************  -->
            <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BodySiteReference">
                <valueReference>
                    <reference value="BodyStructure/UKCore-BodyStructure-MedianCubitalVeinExample" />
                </valueReference>
            </extension>
            <!--  **************extension end**************  -->
            <text value="vein on the inner left arm" />
        </bodySite>
    </collection>
</Specimen>

JSON View

{
    "resourceType": "Specimen",
    "id": "UKCore-Extension-BodySiteReference-Example",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
Appointment.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the booking organization extension associated with an appointment</div>
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

Tree View

Appointment

XML View

<Appointment xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-BookingOrganization-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  ***************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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
Patient.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate whether the patient authorised the donation of body parts after death using the core-defined extension</div>
Patient.extension[0].url[0]http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
Patient.extension[0].value[0]True

Tree View

Patient

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-CadavericDonor-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  **************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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
Composition.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the care setting of a FHIR document</div>
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

Tree View

Composition

XML View

<Composition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-CareSettingType-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  **************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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
Condition.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the extension which adds a SNOMED CT description ID to CodeableConcept</div>
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

Tree View

Condition

XML View

<Condition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-CodingSCTDescId-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
Specimen.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">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</div>
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].collector[0].display[0]Patient: Richard Smith
Specimen.collection[0].collected[0]2022-11-25T16:00:00Z

Tree View

Specimen

XML View

<Specimen xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-CollectionCollector-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <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 ******************   -->
            <display value="Patient: Richard Smith" />
        </collector>
        <collectedDateTime value="2022-11-25T16:00:00Z" />
    </collection>
</Specimen>

JSON View

{
    "resourceType": "Specimen",
    "id": "UKCore-Extension-CollectionCollector-Example",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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"
                    }
                }
            ],
            "display": "Patient: Richard Smith"
        },
        "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.text[0].status[0]additional
DiagnosticReport.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate referencing a composition within a diagnostic report</div>
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

Tree View

DiagnosticReport

XML View

<DiagnosticReport xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-CompositionReference-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--   **************extension start**************   -->
    <extension url="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition">
        <valueReference>
            <reference value="Composition/UKCore-Composition-Discharge-Example" />
        </valueReference>
    </extension>
    <!--   **************extension end**************   -->
    <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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
Condition.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the extension which is used to indicate the episodicity status of a condition</div>
Condition.extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ConditionEpisode
Condition.extension[0].value[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-ConditionEpisodicity
Condition.extension[0].value[0].coding[0].code[0]new
Condition.extension[0].value[0].coding[0].display[0]New
Condition.subject[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example

Tree View

Condition

XML View

<Condition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-ConditionEpisode-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--   **************extension start**************   -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ConditionEpisode">
        <valueCode value="new" />
        <valueCodeableConcept>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-ConditionEpisodicity" />
                <code value="new" />
                <display value="New" />
            </coding>
        </valueCodeableConcept>
    </extension>
    <!--    **************extension end**************    -->
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
</Condition>

JSON View

{
    "resourceType": "Condition",
    "id": "UKCore-Extension-ConditionEpisode-Example",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ConditionEpisode",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-ConditionEpisodicity",
                        "code": "new",
                        "display": "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.text[0].status[0]additional
Patient.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the extension for a patient's contact preferences</div>
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

Tree View

Patient

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-ContactPreference-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  **************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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "extension":  [
        {
            "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"
                            }
                        ]
                    }
                }
            ],
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference"
        }
    ]
}

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

Table View

Patient.id[0]UKCore-Extension-ContactRank-Example
Patient.text[0].status[0]additional
Patient.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the extension for the patient's contact ranking</div>
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

Tree View

Patient

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-ContactRank-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
Patient.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the extension for copy correspondence indicators</div>
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

Tree View

Patient

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-CopyCorrespondenceIndicator-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
ServiceRequest.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate sending an NHS or Private funding category with a service request</div>
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

Tree View

ServiceRequest

XML View

<ServiceRequest xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-Coverage-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  ***************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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
Device.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate recording a blood pressure device with a large cuff</div>
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

Tree View

Device

XML View

<Device xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-CuffSize-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  **************extension start**************  -->
    <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>
    <!--  **************extension end**************  -->
    <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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
Patient.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the extension to indicate the death notification status of the patient</div>
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

Tree View

Patient

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-DeathNotificationStatus-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  **************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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "extension":  [
        {
            "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"
                }
            ],
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus"
        }
    ]
}

An example to illustrate the delivery channel associated with an appointment

Table View

Appointment.id[0]UKCore-Extension-DeliveryChannel-Example
Appointment.text[0].status[0]additional
Appointment.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the delivery channel associated with an appointment</div>
Appointment.extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel
Appointment.extension[0].value[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-DeliveryChannel
Appointment.extension[0].value[0].coding[0].code[0]In-person
Appointment.extension[0].value[0].coding[0].display[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

Tree View

Appointment

XML View

<Appointment xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-DeliveryChannel-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  ***************extension start***************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel">
        <valueCodeableConcept>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-DeliveryChannel" />
                <code value="In-person" />
                <display value="In person" />
            </coding>
        </valueCodeableConcept>
    </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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-DeliveryChannel",
                        "code": "In-person",
                        "display": "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

DiagnosticReport.id[0]UKCore-Extension-DeviceReference-Example
DiagnosticReport.text[0].status[0]additional
DiagnosticReport.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate a device performing a diagnostic report</div>
DiagnosticReport.status[0]final
DiagnosticReport.code[0].coding[0].system[0]http://snomed.info/sct
DiagnosticReport.code[0].coding[0].code[0]721981007
DiagnosticReport.code[0].coding[0].display[0]Diagnostic studies report
DiagnosticReport.subject[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
DiagnosticReport.performer[0].extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference
DiagnosticReport.performer[0].extension[0].value[0].reference[0]Device/UKCore-Device-SoftwareAsAMedicalDevice-Example
DiagnosticReport.performer[0].display[0]Software as a medical device
DiagnosticReport.resultsInterpreter[0].extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference
DiagnosticReport.resultsInterpreter[0].extension[0].value[0].reference[0]Device/UKCore-Device-SoftwareAsAMedicalDevice-Example
DiagnosticReport.resultsInterpreter[0].display[0]Software as a medical device
DiagnosticReport.specimen[0].reference[0]Specimen/UKCore-Specimen-BloodSpecimen-Example
DiagnosticReport.result[0].reference[0]Observation/UKCore-Observation-WhiteCellCount-Example

Tree View

DiagnosticReport

XML View

<DiagnosticReport xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-DeviceReference-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <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 start***************   -->
        <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" />
        <!--   ***************extension end***************   -->
    </performer>
    <resultsInterpreter>
        <!--   ***************extension start***************   -->
        <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" />
        <!--   ***************extension end***************   -->
    </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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "status": "final",
    "code": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "721981007",
                "display": "Diagnostic studies report"
            }
        ]
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "performer":  [
        {
            "extension":  [
                {
                    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference",
                    "valueReference": {
                        "reference": "Device/UKCore-Device-SoftwareAsAMedicalDevice-Example"
                    }
                }
            ],
            "display": "Software as a medical device"
        }
    ],
    "resultsInterpreter":  [
        {
            "extension":  [
                {
                    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference",
                    "valueReference": {
                        "reference": "Device/UKCore-Device-SoftwareAsAMedicalDevice-Example"
                    }
                }
            ],
            "display": "Software as a medical device"
        }
    ],
    "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.text[0].status[0]additional
Encounter.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the extension for an encounter to support the method of discharge from a hospital</div>
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

Tree View

Encounter

XML View

<Encounter xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-DischargeMethod-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  **************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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
Encounter.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the extension which is used to indicate the status of an individual on discharge from an Emergency Care Department</div>
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

Tree View

Encounter

XML View

<Encounter xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-EmergencyCareDischargeStatus-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--   **************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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
Patient.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the extension which shows the ethnic category for a patient</div>
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

Tree View

Patient

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-EthnicCategory-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  **************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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
AllergyIntolerance.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate a reference to results of investigations that confirmed the certainty of the diagnosis for an allergy or intolerance</div>
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

Tree View

AllergyIntolerance

XML View

<AllergyIntolerance xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-Evidence-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  ***************extension start***************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence">
        <valueReference>
            <reference value="DiagnosticReport/UKCore-DiagnosticReport-DiagnosticStudiesReport-Example" />
            <type value="DiagnosticReport" />
        </valueReference>
    </extension>
    <!--  ***************extension end***************  -->
    <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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
Patient.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the core-defined extension which is used to indicate that a person requires an interpreter</div>
Patient.extension[0].url[0]http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
Patient.extension[0].value[0]True

Tree View

Patient

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-InterpreterRequired-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--   **************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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired",
            "valueBoolean": true
        }
    ]
}

Table View

Encounter.id[0]UKCore-Extension-LegalStatus-Example
Encounter.text[0].status[0]additional
Encounter.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the extension which is used to indicate a patient's legal status on admission or discharge</div>
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

Tree View

Encounter

XML View

<Encounter xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-LegalStatus-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  **************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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "extension":  [
        {
            "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)"
                            }
                        ]
                    }
                }
            ],
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus"
        }
    ],
    "status": "finished",
    "class": {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
        "code": "IMP",
        "display": "inpatient encounter"
    }
}

An example to illustrate the date the medication were last issued

Table View

MedicationStatement.id[0]UKCore-Extension-MedicationStatementLastIssueDate-Example
MedicationStatement.text[0].status[0]additional
MedicationStatement.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the date the medication were last issued</div>
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

Tree View

MedicationStatement

XML View

<MedicationStatement xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-MedicationStatementLastIssueDate-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  **************extension start**************  -->
    <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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
List.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate a warning being provided in a list resource</div>
List.extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ListWarningCode
List.extension[0].value[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-ListWarningCode
List.extension[0].value[0].coding[0].code[0]data-in-transit
List.extension[0].value[0].coding[0].display[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

Tree View

List

XML View

<List xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-ListWarningCode-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--   **************extension start**************   -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ListWarningCode">
        <valueCodeableConcept>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-ListWarningCode" />
                <code value="data-in-transit" />
                <display value="Data in Transit" />
            </coding>
        </valueCodeableConcept>
    </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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ListWarningCode",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-ListWarningCode",
                        "code": "data-in-transit",
                        "display": "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.text[0].status[0]additional
Organization.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the extension which shows an organisation's main location</div>
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

Tree View

Organization

XML View

<Organization xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-MainLocation-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  **************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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
MedicationStatement.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">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</div>
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

Tree View

MedicationStatement

XML View

<MedicationStatement xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-MedicationPrescribingOrganizationType-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  **************extension start**************  -->
    <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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
Medication.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the use of a trade family or brand</div>
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 Trading Ltd)

Tree View

Medication

XML View

<Medication xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-MedicationTradeFamily-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  **************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 Trading Ltd)" />
        </coding>
    </code>
</Medication>

JSON View

{
    "resourceType": "Medication",
    "id": "UKCore-Extension-MedicationTradeFamily-Example",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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 Trading Ltd)"
            }
        ]
    }
}

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

Table View

Patient.id[0]UKCore-Extension-NHSNumberUnavailableReason-Example
Patient.text[0].status[0]additional
Patient.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the extension which states the reason a patient does not have a NHS number</div>
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

Tree View

Patient

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-NHSNumberUnavailableReason-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  **************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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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 to illustrate the extension which states the patient's NHS number verification status

Table View

Patient.id[0]UKCore-Extension-NHSNumberVerificationStatus-Example
Patient.text[0].status[0]additional
Patient.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the extension which states the patient's NHS number verification status</div>
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

Tree View

Patient

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-NHSNumberVerificationStatus-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
DiagnosticReport.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate sending a note with a diagnostic report</div>
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]Page Dr Watson on receipt of results.
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
DiagnosticReport.conclusion[0]Inconclusive finding of staphylococcus, no evidence of bacteremia.

Tree View

DiagnosticReport

XML View

<DiagnosticReport xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-Note-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  ***************extension start***************  -->
    <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="Page Dr Watson on receipt of results." />
        </valueAnnotation>
    </extension>
    <!--  ***************extension end***************  -->
    <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>
    <conclusion value="Inconclusive finding of staphylococcus, no evidence of bacteremia." />
</DiagnosticReport>

JSON View

{
    "resourceType": "DiagnosticReport",
    "id": "UKCore-Extension-Note-Example",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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": "Page Dr Watson on receipt of results."
            }
        }
    ],
    "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"
        }
    ],
    "conclusion": "Inconclusive finding of staphylococcus, no evidence of bacteremia."
}

An example to illustrate sending a period

Table View

Organization.id[0]UKCore-Extension-Period-Example
Organization.text[0].status[0]additional
Organization.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate sending a period</div>
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

Tree View

Organization

XML View

<Organization xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-Period-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  **************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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
Patient.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the extension to indicate other contact system(s) for a patient Richard Smith</div>
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].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-OtherContactSystem
Patient.telecom[0].system[0].extension[0].value[0].coding[0].code[0]textphone
Patient.telecom[0].system[0].extension[0].value[0].coding[0].display[0]Minicom (Textphone)
Patient.telecom[0].value[0]+4413513341777
Patient.telecom[0].use[0]home

Tree View

Patient

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-OtherContactSystem-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <telecom>
        <system value="other">
            <!--  **************extension start**************  -->
            <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem">
                <valueCodeableConcept>
                    <coding>
                        <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-OtherContactSystem" />
                        <code value="textphone" />
                        <display value="Minicom (Textphone)" />
                    </coding>
                </valueCodeableConcept>
            </extension>
            <!--  *************extension end ***************** -->
        </system>
        <value value="+4413513341777" />
        <use value="home" />
    </telecom>
</Patient>

JSON View

{
    "resourceType": "Patient",
    "id": "UKCore-Extension-OtherContactSystem-Example",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "telecom":  [
        {
            "system": "other",
            "_system": {
                "extension":  [
                    {
                        "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem",
                        "valueCodeableConcept": {
                            "coding":  [
                                {
                                    "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.text[0].status[0]additional
Encounter.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the extension which is used to indicate the outcome of an outpatient attendance</div>
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

Tree View

Encounter

XML View

<Encounter xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-OutcomeOfAttendance-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--   **************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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
Immunization.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the extension for a vaccination procedure where the parent of the patient is present</div>
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

Tree View

Immunization

XML View

<Immunization xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-ParentPresent-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  **************extension start**************  -->
    <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",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "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.text[0].status[0]additional
FamilyMemberHistory.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate sending the participant involved in recording the activities relating to this family member history</div>
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

Tree View

FamilyMemberHistory

XML View

<FamilyMemberHistory xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-Participant-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!--  ***************extension start***************  -->
    <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>
    <!--  ***************extension ebd***************  -->
    <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" />
            <