UK Core Implementation Guide 0.3.0 STU1

Examples


An example to illustrate whether and under what conditions acknowledgments are required to be returned in response to a message, using the common extension

Table View

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

XML View

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

JSON View

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

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

Table View

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

XML View

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

JSON View

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

An example to illustrate the registered place of birth of the patient using the common extension

Table View

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

XML View

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

JSON View

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

An example to illustrate the patient's birth time using the common extension

Table View

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

XML View

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

JSON View

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

An example to illustrate whether the patient authorized the donation of body parts after death using the common extension

Table View

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

XML View

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

JSON View

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

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

Table View

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

XML View

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

JSON View

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

An example to illustrate the professed religious affiliations of the patient using the common extension

Table View

Command 'table' could not render: File was not found for Patient-Extension-Religion-Example

XML View

Command 'xml' could not render: File was not found for Patient-Extension-Religion-Example

JSON View

Command 'json' could not render: File was not found for Patient-Extension-Religion-Example

An example to illustrate an allergy to Amoxicillin

Table View

AllergyIntolerance.id[0]UKCore-AllergyIntolerance-Amoxicillin-Example
AllergyIntolerance.clinicalStatus[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
AllergyIntolerance.clinicalStatus[0].coding[0].code[0]active
AllergyIntolerance.clinicalStatus[0].coding[0].display[0]Active
AllergyIntolerance.verificationStatus[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/allergyintolerance-verification
AllergyIntolerance.verificationStatus[0].coding[0].code[0]confirmed
AllergyIntolerance.verificationStatus[0].coding[0].display[0]Confirmed
AllergyIntolerance.code[0].coding[0].system[0]http://snomed.info/sct
AllergyIntolerance.code[0].coding[0].code[0]372687004
AllergyIntolerance.code[0].coding[0].display[0]Amoxicillin
AllergyIntolerance.patient[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
AllergyIntolerance.encounter[0].reference[0]Encounter/UKCore-Encounter-InpatientEncounter-Example
AllergyIntolerance.recordedDate[0]2019-12-10T13:00:00+00:00
AllergyIntolerance.recorder[0].reference[0]Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example
AllergyIntolerance.asserter[0].reference[0]Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example
AllergyIntolerance.reaction[0].manifestation[0].coding[0].system[0]http://snomed.info/sct
AllergyIntolerance.reaction[0].manifestation[0].coding[0].code[0]247472004
AllergyIntolerance.reaction[0].manifestation[0].coding[0].display[0]Urticarial rash
AllergyIntolerance.reaction[0].severity[0]mild

XML View

<AllergyIntolerance xmlns="http://hl7.org/fhir">
    <id value="UKCore-AllergyIntolerance-Amoxicillin-Example" />
    <clinicalStatus>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical" />
            <code value="active" />
            <display value="Active" />
        </coding>
    </clinicalStatus>
    <verificationStatus>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-verification" />
            <code value="confirmed" />
            <display value="Confirmed" />
        </coding>
    </verificationStatus>
    <code>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="372687004" />
            <display value="Amoxicillin" />
        </coding>
    </code>
    <patient>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </patient>
    <encounter>
        <reference value="Encounter/UKCore-Encounter-InpatientEncounter-Example" />
    </encounter>
    <recordedDate value="2019-12-10T13:00:00+00:00" />
    <recorder>
        <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" />
    </recorder>
    <asserter>
        <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" />
    </asserter>
    <reaction>
        <manifestation>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="247472004" />
                <display value="Urticarial rash" />
            </coding>
        </manifestation>
        <severity value="mild" />
    </reaction>
</AllergyIntolerance>

JSON View

{
    "resourceType": "AllergyIntolerance",
    "id": "UKCore-AllergyIntolerance-Amoxicillin-Example",
    "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 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-AllergyIntolerance-Extension-AllergyIntolEnd-Example
AllergyIntolerance.clinicalStatus[0].extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd
AllergyIntolerance.clinicalStatus[0].extension[0].extension[0].url[0]endDate
AllergyIntolerance.clinicalStatus[0].extension[0].extension[0].valueDateTime[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].valueString[0]Administrative error corrected on patient record - confirmed that allergy not experienced with the patient.
AllergyIntolerance.clinicalStatus[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
AllergyIntolerance.clinicalStatus[0].coding[0].code[0]inactive
AllergyIntolerance.clinicalStatus[0].coding[0].display[0]Inactive
AllergyIntolerance.verificationStatus[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/allergyintolerance-verification
AllergyIntolerance.verificationStatus[0].coding[0].code[0]confirmed
AllergyIntolerance.verificationStatus[0].coding[0].display[0]Confirmed
AllergyIntolerance.code[0].coding[0].system[0]http://snomed.info/sct
AllergyIntolerance.code[0].coding[0].code[0]372687004
AllergyIntolerance.code[0].coding[0].display[0]Amoxicillin
AllergyIntolerance.patient[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
AllergyIntolerance.encounter[0].reference[0]Encounter/UKCore-Encounter-InpatientEncounter-Example
AllergyIntolerance.recordedDate[0]2019-12-10T13:00:00+00:00
AllergyIntolerance.recorder[0].reference[0]Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example
AllergyIntolerance.asserter[0].reference[0]Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example

XML View

<AllergyIntolerance xmlns="http://hl7.org/fhir">
    <id value="UKCore-AllergyIntolerance-Extension-AllergyIntolEnd-Example" />
    <clinicalStatus>
        <!--  **************extension start**************  -->
        <!-- This supports the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid.. -->
        <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd">
            <extension url="endDate">
                <valueDateTime value="2021-07-20T17:10:00+00:00" />
            </extension>
            <extension url="reasonEnded">
                <valueString value="Administrative error corrected on patient record - confirmed that allergy not experienced with the patient." />
            </extension>
        </extension>
        <!--  **************extension end**************  -->
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical" />
            <code value="inactive" />
            <display value="Inactive" />
        </coding>
    </clinicalStatus>
    <verificationStatus>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-verification" />
            <code value="confirmed" />
            <display value="Confirmed" />
        </coding>
    </verificationStatus>
    <code>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="372687004" />
            <display value="Amoxicillin" />
        </coding>
    </code>
    <patient>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </patient>
    <encounter>
        <reference value="Encounter/UKCore-Encounter-InpatientEncounter-Example" />
    </encounter>
    <recordedDate value="2019-12-10T13:00:00+00:00" />
    <recorder>
        <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" />
    </recorder>
    <asserter>
        <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" />
    </asserter>
</AllergyIntolerance>

JSON View

{
    "resourceType": "AllergyIntolerance",
    "id": "UKCore-AllergyIntolerance-Extension-AllergyIntolEnd-Example",
    "clinicalStatus": {
        "extension":  [
            {
                "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd",
                "extension":  [
                    {
                        "url": "endDate",
                        "valueDateTime": "2021-07-20T17:10:00+00:00"
                    },
                    {
                        "url": "reasonEnded",
                        "valueString": "Administrative error corrected on patient record - confirmed that allergy not experienced with the patient."
                    }
                ]
            }
        ],
        "coding":  [
            {
                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                "code": "inactive",
                "display": "Inactive"
            }
        ]
    },
    "verificationStatus": {
        "coding":  [
            {
                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
                "code": "confirmed",
                "display": "Confirmed"
            }
        ]
    },
    "code": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "372687004",
                "display": "Amoxicillin"
            }
        ]
    },
    "patient": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "encounter": {
        "reference": "Encounter/UKCore-Encounter-InpatientEncounter-Example"
    },
    "recordedDate": "2019-12-10T13:00:00+00:00",
    "recorder": {
        "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example"
    },
    "asserter": {
        "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example"
    }
}

An example to illustrate an allergy that was entered in error

Table View

AllergyIntolerance.id[0]UKCore-AllergyIntolerance-EnteredInError-Example
AllergyIntolerance.verificationStatus[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/allergyintolerance-verification
AllergyIntolerance.verificationStatus[0].coding[0].code[0]entered-in-error
AllergyIntolerance.verificationStatus[0].coding[0].display[0]Entered in Error
AllergyIntolerance.code[0].coding[0].system[0]http://snomed.info/sct
AllergyIntolerance.code[0].coding[0].code[0]372687004
AllergyIntolerance.code[0].coding[0].display[0]Amoxicillin
AllergyIntolerance.patient[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
AllergyIntolerance.encounter[0].reference[0]Encounter/UKCore-Encounter-InpatientEncounter-Example
AllergyIntolerance.recordedDate[0]2019-12-10T13:00:00+00:00
AllergyIntolerance.recorder[0].reference[0]Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example
AllergyIntolerance.asserter[0].reference[0]Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example

XML View

<AllergyIntolerance xmlns="http://hl7.org/fhir">
    <id value="UKCore-AllergyIntolerance-EnteredInError-Example" />
    <verificationStatus>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-verification" />
            <code value="entered-in-error" />
            <display value="Entered in Error" />
        </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-AllergyIntolerance-EnteredInError-Example",
    "verificationStatus": {
        "coding":  [
            {
                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
                "code": "entered-in-error",
                "display": "Entered in Error"
            }
        ]
    },
    "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 a reference to results of investigations that confirmed the certainty of the diagnosis for an allergy or intolerance

Table View

AllergyIntolerance.id[0]UKCore-AllergyIntolerance-Extension-Evidence-Example
AllergyIntolerance.extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence
AllergyIntolerance.extension[0].valueReference[0].reference[0]DiagnosticReport/UKCore-DiagnosticReport-DiagnosticStudiesReport-Example
AllergyIntolerance.extension[0].valueReference[0].type[0]DiagnosticReport
AllergyIntolerance.clinicalStatus[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
AllergyIntolerance.clinicalStatus[0].coding[0].code[0]active
AllergyIntolerance.clinicalStatus[0].coding[0].display[0]Active
AllergyIntolerance.verificationStatus[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/allergyintolerance-verification
AllergyIntolerance.verificationStatus[0].coding[0].code[0]confirmed
AllergyIntolerance.verificationStatus[0].coding[0].display[0]Confirmed
AllergyIntolerance.code[0].coding[0].system[0]http://snomed.info/sct
AllergyIntolerance.code[0].coding[0].code[0]372687004
AllergyIntolerance.code[0].coding[0].display[0]Amoxicillin
AllergyIntolerance.patient[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
AllergyIntolerance.encounter[0].reference[0]Encounter/UKCore-Encounter-InpatientEncounter-Example
AllergyIntolerance.recordedDate[0]2019-12-10T13:00:00+00:00
AllergyIntolerance.recorder[0].reference[0]Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example
AllergyIntolerance.asserter[0].reference[0]Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example
AllergyIntolerance.reaction[0].manifestation[0].coding[0].system[0]http://snomed.info/sct
AllergyIntolerance.reaction[0].manifestation[0].coding[0].code[0]247472004
AllergyIntolerance.reaction[0].manifestation[0].coding[0].display[0]Urticarial rash
AllergyIntolerance.reaction[0].severity[0]mild

XML View

<AllergyIntolerance xmlns="http://hl7.org/fhir">
    <id value="UKCore-AllergyIntolerance-Extension-Evidence-Example" />
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence">
        <valueReference>
            <reference value="DiagnosticReport/UKCore-DiagnosticReport-DiagnosticStudiesReport-Example" />
            <type value="DiagnosticReport" />
        </valueReference>
    </extension>
    <clinicalStatus>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical" />
            <code value="active" />
            <display value="Active" />
        </coding>
    </clinicalStatus>
    <verificationStatus>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-verification" />
            <code value="confirmed" />
            <display value="Confirmed" />
        </coding>
    </verificationStatus>
    <code>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="372687004" />
            <display value="Amoxicillin" />
        </coding>
    </code>
    <patient>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </patient>
    <encounter>
        <reference value="Encounter/UKCore-Encounter-InpatientEncounter-Example" />
    </encounter>
    <recordedDate value="2019-12-10T13:00:00+00:00" />
    <recorder>
        <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" />
    </recorder>
    <asserter>
        <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" />
    </asserter>
    <reaction>
        <manifestation>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="247472004" />
                <display value="Urticarial rash" />
            </coding>
        </manifestation>
        <severity value="mild" />
    </reaction>
</AllergyIntolerance>

JSON View

{
    "resourceType": "AllergyIntolerance",
    "id": "UKCore-AllergyIntolerance-Extension-Evidence-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence",
            "valueReference": {
                "reference": "DiagnosticReport/UKCore-DiagnosticReport-DiagnosticStudiesReport-Example",
                "type": "DiagnosticReport"
            }
        }
    ],
    "clinicalStatus": {
        "coding":  [
            {
                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                "code": "active",
                "display": "Active"
            }
        ]
    },
    "verificationStatus": {
        "coding":  [
            {
                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
                "code": "confirmed",
                "display": "Confirmed"
            }
        ]
    },
    "code": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "372687004",
                "display": "Amoxicillin"
            }
        ]
    },
    "patient": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "encounter": {
        "reference": "Encounter/UKCore-Encounter-InpatientEncounter-Example"
    },
    "recordedDate": "2019-12-10T13:00:00+00:00",
    "recorder": {
        "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example"
    },
    "asserter": {
        "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example"
    },
    "reaction":  [
        {
            "manifestation":  [
                {
                    "coding":  [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "247472004",
                            "display": "Urticarial rash"
                        }
                    ]
                }
            ],
            "severity": "mild"
        }
    ]
}

An example to illustrate a bundled allergy list

Table View

Bundle.id[0]UKCore-Bundle-BundledAllergyList-Example
Bundle.type[0]collection
Bundle.entry[0].fullUrl[0]urn:uuid:d043d2b6-5782-4536-88b6-e537973a09fb
Bundle.entry[0].resource[0].id[0]UKCore-Allergy-List-Example
Bundle.entry[0].resource[0].status[0]current
Bundle.entry[0].resource[0].mode[0]snapshot
Bundle.entry[0].resource[0].code[0].coding[0].system[0]http://snomed.info/sct
Bundle.entry[0].resource[0].code[0].coding[0].code[0]886921000000105
Bundle.entry[0].resource[0].code[0].coding[0].display[0]Allergies and adverse reactions
Bundle.entry[0].resource[0].subject[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
Bundle.entry[0].resource[0].date[0]2019-12-10T13:00:00+00:00
Bundle.entry[0].resource[0].entry[0].item[0].reference[0]urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4
Bundle.entry[1].fullUrl[0]urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4
Bundle.entry[1].resource[0].id[0]efae5859-28df-4e7d-be91-6df56d8215e4
Bundle.entry[1].resource[0].clinicalStatus[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
Bundle.entry[1].resource[0].clinicalStatus[0].coding[0].code[0]active
Bundle.entry[1].resource[0].clinicalStatus[0].coding[0].display[0]Active
Bundle.entry[1].resource[0].verificationStatus[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/allergyintolerance-verification
Bundle.entry[1].resource[0].verificationStatus[0].coding[0].code[0]confirmed
Bundle.entry[1].resource[0].verificationStatus[0].coding[0].display[0]Confirmed
Bundle.entry[1].resource[0].code[0].coding[0].system[0]http://snomed.info/sct
Bundle.entry[1].resource[0].code[0].coding[0].code[0]372687004
Bundle.entry[1].resource[0].code[0].coding[0].display[0]Amoxicillin
Bundle.entry[1].resource[0].patient[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
Bundle.entry[1].resource[0].encounter[0].reference[0]Encounter/UKCore-Encounter-InpatientEncounter-Example
Bundle.entry[1].resource[0].recordedDate[0]2019-12-10T13:00:00+00:00
Bundle.entry[1].resource[0].recorder[0].reference[0]Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example
Bundle.entry[1].resource[0].asserter[0].reference[0]Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example
Bundle.entry[1].resource[0].reaction[0].manifestation[0].coding[0].system[0]http://snomed.info/sct
Bundle.entry[1].resource[0].reaction[0].manifestation[0].coding[0].code[0]247472004
Bundle.entry[1].resource[0].reaction[0].manifestation[0].coding[0].display[0]Urticarial rash
Bundle.entry[1].resource[0].reaction[0].severity[0]mild

XML View

<Bundle xmlns="http://hl7.org/fhir">
    <id value="UKCore-Bundle-BundledAllergyList-Example" />
    <type value="collection" />
    <entry>
        <fullUrl value="urn:uuid:d043d2b6-5782-4536-88b6-e537973a09fb" />
        <resource>
            <List>
                <id value="UKCore-Allergy-List-Example" />
                <status value="current" />
                <mode value="snapshot" />
                <code>
                    <coding>
                        <system value="http://snomed.info/sct" />
                        <code value="886921000000105" />
                        <display value="Allergies and adverse reactions" />
                    </coding>
                </code>
                <subject>
                    <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
                </subject>
                <date value="2019-12-10T13:00:00+00:00" />
                <entry>
                    <item>
                        <reference value="urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4" />
                    </item>
                </entry>
            </List>
        </resource>
    </entry>
    <entry>
        <fullUrl value="urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4" />
        <resource>
            <AllergyIntolerance>
                <id value="efae5859-28df-4e7d-be91-6df56d8215e4" />
                <clinicalStatus>
                    <coding>
                        <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical" />
                        <code value="active" />
                        <display value="Active" />
                    </coding>
                </clinicalStatus>
                <verificationStatus>
                    <coding>
                        <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-verification" />
                        <code value="confirmed" />
                        <display value="Confirmed" />
                    </coding>
                </verificationStatus>
                <code>
                    <coding>
                        <system value="http://snomed.info/sct" />
                        <code value="372687004" />
                        <display value="Amoxicillin" />
                    </coding>
                </code>
                <patient>
                    <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
                </patient>
                <encounter>
                    <reference value="Encounter/UKCore-Encounter-InpatientEncounter-Example" />
                </encounter>
                <recordedDate value="2019-12-10T13:00:00+00:00" />
                <recorder>
                    <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" />
                </recorder>
                <asserter>
                    <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" />
                </asserter>
                <reaction>
                    <manifestation>
                        <coding>
                            <system value="http://snomed.info/sct" />
                            <code value="247472004" />
                            <display value="Urticarial rash" />
                        </coding>
                    </manifestation>
                    <severity value="mild" />
                </reaction>
            </AllergyIntolerance>
        </resource>
    </entry>
</Bundle>

JSON View

{
    "resourceType": "Bundle",
    "id": "UKCore-Bundle-BundledAllergyList-Example",
    "type": "collection",
    "entry":  [
        {
            "fullUrl": "urn:uuid:d043d2b6-5782-4536-88b6-e537973a09fb",
            "resource": {
                "resourceType": "List",
                "id": "UKCore-Allergy-List-Example",
                "status": "current",
                "mode": "snapshot",
                "code": {
                    "coding":  [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "886921000000105",
                            "display": "Allergies and adverse reactions"
                        }
                    ]
                },
                "subject": {
                    "reference": "Patient/UKCore-Patient-RichardSmith-Example"
                },
                "date": "2019-12-10T13:00:00+00:00",
                "entry":  [
                    {
                        "item": {
                            "reference": "urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4"
                        }
                    }
                ]
            }
        },
        {
            "fullUrl": "urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4",
            "resource": {
                "resourceType": "AllergyIntolerance",
                "id": "efae5859-28df-4e7d-be91-6df56d8215e4",
                "clinicalStatus": {
                    "coding":  [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                            "code": "active",
                            "display": "Active"
                        }
                    ]
                },
                "verificationStatus": {
                    "coding":  [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
                            "code": "confirmed",
                            "display": "Confirmed"
                        }
                    ]
                },
                "code": {
                    "coding":  [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "372687004",
                            "display": "Amoxicillin"
                        }
                    ]
                },
                "patient": {
                    "reference": "Patient/UKCore-Patient-RichardSmith-Example"
                },
                "encounter": {
                    "reference": "Encounter/UKCore-Encounter-InpatientEncounter-Example"
                },
                "recordedDate": "2019-12-10T13:00:00+00:00",
                "recorder": {
                    "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example"
                },
                "asserter": {
                    "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example"
                },
                "reaction":  [
                    {
                        "manifestation":  [
                            {
                                "coding":  [
                                    {
                                        "system": "http://snomed.info/sct",
                                        "code": "247472004",
                                        "display": "Urticarial rash"
                                    }
                                ]
                            }
                        ],
                        "severity": "mild"
                    }
                ]
            }
        }
    ]
}

An example to illustrate a composition containing a discharge summary

Table View

Composition.id[0]UKCore-Composition-Discharge-Example
Composition.extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType
Composition.extension[0].valueCodeableConcept[0].coding[0].system[0]http://snomed.info/sct
Composition.extension[0].valueCodeableConcept[0].coding[0].code[0]310000008
Composition.extension[0].valueCodeableConcept[0].coding[0].display[0]Accident and Emergency service
Composition.identifier[0].system[0]https://tools.ietf.org/html/rfc4122
Composition.identifier[0].value[0]2d361270-039f-4a48-827b-ef255ff8b6c4
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.subject[0].reference[0]urn:uuid:c8225cc8-8026-466f-80f8-fc2832a4b9d5
Composition.encounter[0].reference[0]urn:uuid:9a20cb92-354a-4015-82ec-ab0252efc5b9
Composition.date[0]2021-02-12T19:00:00+00:00
Composition.author[0].reference[0]urn:uuid:369d88a8-9f6b-407f-8560-6ee9d7ccc8bb
Composition.title[0]Accident & Emergency Discharge summary
Composition.custodian[0].reference[0]urn:uuid:120633ae-1a20-4e0e-b807-b78fb59679cc
Composition.section[0].title[0]Allergies and adverse reaction
Composition.section[0].code[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings
Composition.section[0].code[0].coding[0].code[0]allergies-and-adverse-reaction
Composition.section[0].code[0].coding[0].display[0]Allergies and adverse reaction
Composition.section[0].text[0].status[0]additional
Composition.section[0].text[0].div[0]
Causative agentPenicillin -class of antibiotic
Description of reactionEruption due to drug
SeverityMild
CertaintyCertain
CommentNo swelling
Composition.section[0].entry[0].reference[0]urn:uuid:b37c89af-c5da-425f-8e6d-58c043ccf94b
Composition.section[1].title[0]Attendance details
Composition.section[1].code[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings
Composition.section[1].code[0].coding[0].code[0]attendance-details
Composition.section[1].code[0].coding[0].display[0]Attendance details
Composition.section[1].text[0].status[0]additional
Composition.section[1].text[0].div[0]
Date and time of contact12-Feb-2015 07:00
Composition.section[2].title[0]Clinical narrative
Composition.section[2].code[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings
Composition.section[2].code[0].coding[0].code[0]clinical-narrative
Composition.section[2].code[0].coding[0].display[0]Clinical narrative
Composition.section[2].text[0].status[0]additional
Composition.section[2].text[0].div[0]
Clinical narrative

60 year old man complaining of chest pain lasting around 2 hours.

Examination unremarkable.

Inferior ischaemic changes on ECG.

Full Blood Count 

TestValueUnitsReference Range
White Cell Count11.1x10*9/L3.5 - 10.0
Red Cell Count5.0x10*12/L4.25 - 5.75 
Haemoglobin150g/L13.0 - 17.0
Haematocrit0.230L/L0.400 - 0.500
Mean Cell Volume90fL84 - 98
Mean Cell Hb33.0pg27.5 - 32.0
Mean Cell Hb Con34.0pg31.0 - 35.0
RDW12.0%< 14.5
Platelet Count300x10*9/L150 - 400

Machine Differential 

TestValueUnitsReference Range
Neutrophils7.0x10*9/L1.7 - 7.5
Lymphocytes3.5x10*9/L1.0 - 3.5
Monocytes0.3x10*9/L< 0.6
Eosinophils0.4x10*9/L< 0.4
Basophils0.1x10*9/L< 0.1
LUCs0.2x10*9/L< 0.4
                                
Composition.section[3].title[0]Contact for further information
Composition.section[3].code[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings
Composition.section[3].code[0].coding[0].code[0]contact-for-further-information
Composition.section[3].code[0].coding[0].display[0]Contact for further information
Composition.section[3].text[0].status[0]additional
Composition.section[3].text[0].div[0]
Contact for further informationDr Paul Rastall Tel: 0113 6323200
Composition.section[4].title[0]Diagnoses
Composition.section[4].code[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings
Composition.section[4].code[0].coding[0].code[0]diagnoses
Composition.section[4].code[0].coding[0].display[0]Diagnoses
Composition.section[4].text[0].status[0]generated
Composition.section[4].text[0].div[0]
Diagnosis nameAcute ST segment elevation myocardial infarction
Composition.section[4].entry[0].reference[0]urn:uuid:0a46351b-bfe1-4085-956e-15d3b172e36f
Composition.section[5].title[0]Discharge details
Composition.section[5].code[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings
Composition.section[5].code[0].coding[0].code[0]discharge-details
Composition.section[5].code[0].coding[0].display[0]Discharge details
Composition.section[5].text[0].status[0]extensions
Composition.section[5].text[0].div[0]
Discharge statusStreamed from emergency department to urgent care service following initial assessment
Date/time of discharge12-Feb-2015 08:00
Discharge destinationNHS other Hospital Provider - Ward for general Patients or the younger physically disabled
Composition.section[5].entry[0].reference[0]urn:uuid:9a20cb92-354a-4015-82ec-ab0252efc5b9
Composition.section[6].title[0]GP practice
Composition.section[6].code[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings
Composition.section[6].code[0].coding[0].code[0]general-practitioner-practice
Composition.section[6].code[0].coding[0].display[0]General practitioner practice
Composition.section[6].text[0].status[0]additional
Composition.section[6].text[0].div[0]
GP name

Prefix: Dr

Given Name: John

Family Name: Lorenzo

GP practice details

Name: MGP Medical Centre

Address:

Address Line: 1 MGP House, Overtown

City: Leeds

Post Code: LS21 7PA

Composition.section[6].entry[0].reference[0]urn:uuid:e4058bb2-bf1a-47a4-ab10-1471161380a1
Composition.section[7].title[0]Information and advice given
Composition.section[7].code[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings
Composition.section[7].code[0].coding[0].code[0]information-and-advice-given
Composition.section[7].code[0].coding[0].display[0]Information and advice given
Composition.section[7].text[0].status[0]additional
Composition.section[7].text[0].div[0]
Information and advice givenPatient advised to be admitted to ward for further tests after ECG results showed inferior ischaemic changes.
Composition.section[8].title[0]Medications and medical devices
Composition.section[8].code[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings
Composition.section[8].code[0].coding[0].code[0]medications-and-medical-devices
Composition.section[8].code[0].coding[0].display[0]Medications and medical devices
Composition.section[8].text[0].status[0]additional
Composition.section[8].text[0].div[0]
Medication nameRamipril 2.5mg tablets (A A H Pharmaceuticals Ltd)
FormTablet
RouteOral
Dose directions descriptionOne 2.5mg tablet once a day.
StatusContinued
Medication nameAspirin 75mg tablets (Sigma Pharmaceuticals Plc)
FormTablet
RouteOral
Dose directions descriptionTake one 75mg tablet once a day.
StatusContinued
Medication nameSimvastatin 40mg tablets (Brown & Burk UK Ltd)
FormTablet
RouteOral
Dose directions descriptionTake one 40mg tablet once a day.
StatusContinued
Medication nameBisoprolol 5mg tablets (A A H Pharmaceuticals Ltd)
FormTablet
RouteOral
Dose directions descriptionTake one 5mg tablet daily.
Comment/recommendationRecommend Uptitrate according to BP and HR
StatusContinued
Composition.section[8].entry[0].reference[0]urn:uuid:e3c8b45f-22d4-4ce6-970c-10a959831dca
Composition.section[9].title[0]Patient demographics
Composition.section[9].code[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings
Composition.section[9].code[0].coding[0].code[0]patient-demographics
Composition.section[9].code[0].coding[0].display[0]Patient demographics
Composition.section[9].text[0].status[0]generated
Composition.section[9].text[0].div[0]
Patient name

Prefix: Mr

Given Name: Richard

Family Name: Smith

Date of birth1 January 1957
GenderMale
NHS number1352465790
Patient address

Address Line: 21, Grove Street, Overtown

City: Leeds

Post Code: LS21 1PF

Composition.section[9].entry[0].reference[0]urn:uuid:c8225cc8-8026-466f-80f8-fc2832a4b9d5
Composition.section[10].title[0]Person completing record
Composition.section[10].code[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings
Composition.section[10].code[0].coding[0].code[0]person-completing-record
Composition.section[10].code[0].coding[0].display[0]Person completing record
Composition.section[10].text[0].status[0]generated
Composition.section[10].text[0].div[0]
Name

Prefix: Dr

Given Name: Paul

Family Name: Rastall

Composition.section[10].entry[0].reference[0]urn:uuid:369d88a8-9f6b-407f-8560-6ee9d7ccc8bb
Composition.section[11].title[0]Plan and requested actions
Composition.section[11].code[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings
Composition.section[11].code[0].coding[0].code[0]plan-and-requested-actions
Composition.section[11].code[0].coding[0].display[0]Plan and requested actions
Composition.section[11].text[0].status[0]additional
Composition.section[11].text[0].div[0]
Action

Patient has agreed to be admitted to Cramer ward for further tests to investigate causes of his chest pain on 12 February 2015.

Person responsible: Dr. Paul Rastall (Accident and Emergency Consultant, St. James's University Hospital Accident and Emergency Department)

Status: Completed

Outcome: Patient expects to find out the more information about the reasons for his chest pain when tests are carried out after admission.

Composition.section[12].title[0]Presenting complaints or issues
Composition.section[12].code[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings
Composition.section[12].code[0].coding[0].code[0]presenting-complaints-or-issues
Composition.section[12].code[0].coding[0].display[0]Presenting complaints or issues
Composition.section[12].text[0].status[0]generated
Composition.section[12].text[0].div[0]
Presenting complaints or issueChest pain
Composition.section[12].entry[0].reference[0]urn:uuid:0a46351b-bfe1-4085-956e-15d3b172e36f
Composition.section[13].title[0]Procedures
Composition.section[13].code[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings
Composition.section[13].code[0].coding[0].code[0]procedures
Composition.section[13].code[0].coding[0].display[0]Procedures
Composition.section[13].text[0].status[0]additional
Composition.section[13].text[0].div[0]
Procedure nameElectrocardiographic monitoring
CommentECGs showed inferior ischaemic changes.
Composition.section[13].entry[0].reference[0]urn:uuid:1e04ce96-6e52-4f82-bc26-93c89c5836a1
Composition.section[14].title[0]Referrer details
Composition.section[14].code[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings
Composition.section[14].code[0].coding[0].code[0]referrer-details
Composition.section[14].code[0].coding[0].display[0]Referrer details
Composition.section[14].text[0].status[0]additional
Composition.section[14].text[0].div[0]
Referrer detailsSelf-referral to accident and emergency department
Composition.section[15].title[0]Senior reviewing clinician
Composition.section[15].code[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings
Composition.section[15].code[0].coding[0].code[0]senior-reviewing-clinician
Composition.section[15].code[0].coding[0].display[0]Senior reviewing clinician
Composition.section[15].text[0].status[0]generated
Composition.section[15].text[0].div[0]
Name

Prefix: Mr

Family Name: Abacus

Composition.section[15].entry[0].reference[0]urn:uuid:d25fd1c6-2658-4db7-9af0-86c5f95e8ec9

XML View

<Composition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Composition-Discharge-Example" />
    <!--  Extension to carry details of the Correspondence Care Setting Type.  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType">
        <valueCodeableConcept>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="310000008" />
                <display value="Accident and Emergency service" />
            </coding>
        </valueCodeableConcept>
    </extension>
    <identifier>
        <system value="https://tools.ietf.org/html/rfc4122" />
        <value value="2d361270-039f-4a48-827b-ef255ff8b6c4" />
    </identifier>
    <!-- The workflow/clinical status of this composition. 
The status is a marker for the clinical standing of the document. -->
    <status value="final" />
    <type>
        <!-- Discharge Summary document type -->
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="373942005" />
            <display value="Discharge summary" />
        </coding>
    </type>
    <!-- Reference to the patient subject of the Composition -->
    <subject>
        <reference value="urn:uuid:c8225cc8-8026-466f-80f8-fc2832a4b9d5" />
    </subject>
    <!-- Reference to the clinical encounter or type of care this documentation is associated with. -->
    <encounter>
        <reference value="urn:uuid:9a20cb92-354a-4015-82ec-ab0252efc5b9" />
    </encounter>
    <!-- The composition editing time, when the composition was last logically changed by the author. -->
    <date value="2021-02-12T19:00:00+00:00" />
    <!-- Identifies who is responsible for the information in the composition, 
not necessarily who typed it in -->
    <author>
        <reference value="urn:uuid:369d88a8-9f6b-407f-8560-6ee9d7ccc8bb" />
    </author>
    <title value="Accident &amp; Emergency Discharge summary" />
    <!-- Identifies the organisation responsible for ongoing maintenance of and 
access to the composition/document information. -->
    <custodian>
        <reference value="urn:uuid:120633ae-1a20-4e0e-b807-b78fb59679cc" />
    </custodian>
    <!-- Allergies and adverse reactions -->
    <section>
        <title value="Allergies and adverse reaction" />
        <code>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings" />
                <code value="allergies-and-adverse-reaction" />
                <display value="Allergies and adverse reaction" />
            </coding>
        </code>
        <text>
            <status value="additional" />
            <div xmlns="http://www.w3.org/1999/xhtml"><table width="100%"><tbody><tr><th>Causative agent</th><td>Penicillin -class of antibiotic</td></tr><tr><th>Description of reaction</th><td>Eruption due to drug</td></tr><tr><th>Severity</th><td>Mild</td></tr><tr><th>Certainty</th><td>Certain</td></tr><tr><th>Comment</th><td>No swelling</td></tr></tbody></table></div>
        </text>
        <!-- Reference to Allergies List as the source of information for this section -->
        <entry>
            <reference value="urn:uuid:b37c89af-c5da-425f-8e6d-58c043ccf94b" />
        </entry>
    </section>
    <!-- Attendance details -->
    <section>
        <title value="Attendance details" />
        <code>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings" />
                <code value="attendance-details" />
                <display value="Attendance details" />
            </coding>
        </code>
        <text>
            <status value="additional" />
            <div xmlns="http://www.w3.org/1999/xhtml"><table width="100%"><tbody><tr><th>Date and time of contact</th><td>12-Feb-2015 07:00</td></tr></tbody></table></div>
        </text>
    </section>
    <!-- Clinical narrative -->
    <section>
        <title value="Clinical narrative" />
        <code>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings" />
                <code value="clinical-narrative" />
                <display value="Clinical narrative" />
            </coding>
        </code>
        <text>
            <status value="additional" />
            <div xmlns="http://www.w3.org/1999/xhtml"><table width="100%"><tbody><tr><th>Clinical narrative</th></tr><tr><td><p>60 year old man complaining of chest pain lasting around 2 hours.</p><p>Examination unremarkable.</p><p>Inferior ischaemic changes on ECG.</p></td></tr></tbody></table><table><tbody><tr><td><pre>
Full Blood Count 

TestValueUnitsReference Range
White Cell Count11.1x10*9/L3.5 - 10.0
Red Cell Count5.0x10*12/L4.25 - 5.75 
Haemoglobin150g/L13.0 - 17.0
Haematocrit0.230L/L0.400 - 0.500
Mean Cell Volume90fL84 - 98
Mean Cell Hb33.0pg27.5 - 32.0
Mean Cell Hb Con34.0pg31.0 - 35.0
RDW12.0%&lt; 14.5
Platelet Count300x10*9/L150 - 400

Machine Differential 

TestValueUnitsReference Range
Neutrophils7.0x10*9/L1.7 - 7.5
Lymphocytes3.5x10*9/L1.0 - 3.5
Monocytes0.3x10*9/L&lt; 0.6
Eosinophils0.4x10*9/L&lt; 0.4
Basophils0.1x10*9/L&lt; 0.1
LUCs0.2x10*9/L&lt; 0.4
                                </pre></td></tr></tbody></table></div>
        </text>
    </section>
    <!-- Contact for further information -->
    <section>
        <title value="Contact for further information" />
        <code>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings" />
                <code value="contact-for-further-information" />
                <display value="Contact for further information" />
            </coding>
        </code>
        <text>
            <status value="additional" />
            <div xmlns="http://www.w3.org/1999/xhtml"><table width="100%"><tbody><tr><th>Contact for further information</th><td>Dr Paul Rastall Tel: 0113 6323200</td></tr></tbody></table></div>
        </text>
    </section>
    <!-- Diagnoses -->
    <section>
        <title value="Diagnoses" />
        <code>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings" />
                <code value="diagnoses" />
                <display value="Diagnoses" />
            </coding>
        </code>
        <text>
            <status value="generated" />
            <div xmlns="http://www.w3.org/1999/xhtml"><table width="100%"><tbody><tr><th>Diagnosis name</th><td>Acute ST segment elevation myocardial infarction</td></tr></tbody></table></div>
        </text>
        <!-- Reference to information in the Condition list resource -->
        <entry>
            <reference value="urn:uuid:0a46351b-bfe1-4085-956e-15d3b172e36f" />
        </entry>
    </section>
    <!-- Discharge details -->
    <section>
        <title value="Discharge details" />
        <code>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings" />
                <code value="discharge-details" />
                <display value="Discharge details" />
            </coding>
        </code>
        <text>
            <status value="extensions" />
            <div xmlns="http://www.w3.org/1999/xhtml"><table width="100%"><tbody><tr><th>Discharge status</th><td>Streamed from emergency department to urgent care service following initial assessment</td></tr><tr><th>Date/time of discharge</th><td>12-Feb-2015 08:00</td></tr><tr><th>Discharge destination</th><td>NHS other Hospital Provider - Ward for general Patients or the younger physically disabled</td></tr></tbody></table></div>
        </text>
        <!-- Reference to the Encounter entry as the source of information for this section -->
        <entry>
            <reference value="urn:uuid:9a20cb92-354a-4015-82ec-ab0252efc5b9" />
        </entry>
    </section>
    <!--  GP Practice -->
    <section>
        <title value="GP practice" />
        <code>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings" />
                <code value="general-practitioner-practice" />
                <display value="General practitioner practice" />
            </coding>
        </code>
        <text>
            <status value="additional" />
            <div xmlns="http://www.w3.org/1999/xhtml"><table width="100%"><tbody><tr><th>GP name</th><td><p>Prefix: Dr</p><p>Given Name: John</p><p>Family Name: Lorenzo</p></td></tr><tr><th>GP practice details</th><td><p>Name: MGP Medical Centre</p><p>Address:</p><p>Address Line: 1 MGP House, Overtown</p><p>City: Leeds</p><p>Post Code: LS21 7PA</p></td></tr></tbody></table></div>
        </text>
        <!-- Reference to the Organisation entry as the source of information for this section -->
        <entry>
            <reference value="urn:uuid:e4058bb2-bf1a-47a4-ab10-1471161380a1" />
        </entry>
    </section>
    <!--  Information and advice given -->
    <section>
        <title value="Information and advice given" />
        <code>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings" />
                <code value="information-and-advice-given" />
                <display value="Information and advice given" />
            </coding>
        </code>
        <text>
            <status value="additional" />
            <div xmlns="http://www.w3.org/1999/xhtml"><table width="100%"><tbody><tr><th>Information and advice given</th><td>Patient advised to be admitted to ward for further tests after ECG results 
showed inferior ischaemic changes.</td></tr></tbody></table></div>
        </text>
    </section>
    <!-- Medications and medical devices -->
    <section>
        <title value="Medications and medical devices" />
        <code>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings" />
                <code value="medications-and-medical-devices" />
                <display value="Medications and medical devices" />
            </coding>
        </code>
        <text>
            <status value="additional" />
            <div xmlns="http://www.w3.org/1999/xhtml"><table width="100%"><tbody><tr><th>Medication name</th><td>Ramipril 2.5mg tablets (A A H Pharmaceuticals Ltd)</td></tr><tr><th>Form</th><td>Tablet</td></tr><tr><th>Route</th><td>Oral</td></tr><tr><th>Dose directions description</th><td>One 2.5mg tablet once a day.</td></tr><tr><th>Status</th><td>Continued</td></tr></tbody></table><table width="100%"><tbody><tr><th>Medication name</th><td>Aspirin 75mg tablets (Sigma Pharmaceuticals Plc)</td></tr><tr><th>Form</th><td>Tablet</td></tr><tr><th>Route</th><td>Oral</td></tr><tr><th>Dose directions description</th><td>Take one 75mg tablet once a day.</td></tr><tr><th>Status</th><td>Continued</td></tr></tbody></table><table width="100%"><tbody><tr><th>Medication name</th><td>Simvastatin 40mg tablets (Brown &amp; Burk UK Ltd)</td></tr><tr><th>Form</th><td>Tablet</td></tr><tr><th>Route</th><td>Oral</td></tr><tr><th>Dose directions description</th><td>Take one 40mg tablet once a day.</td></tr><tr><th>Status</th><td>Continued</td></tr></tbody></table><table width="100%"><tbody><tr><th>Medication name</th><td>Bisoprolol 5mg tablets (A A H Pharmaceuticals Ltd)</td></tr><tr><th>Form</th><td>Tablet</td></tr><tr><th>Route</th><td>Oral</td></tr><tr><th>Dose directions description</th><td>Take one 5mg tablet daily.</td></tr><tr><th>Comment/recommendation</th><td>Recommend Uptitrate according to BP and HR</td></tr><tr><th>Status</th><td>Continued</td></tr></tbody></table></div>
        </text>
        <!-- Reference to medication list -->
        <entry>
            <reference value="urn:uuid:e3c8b45f-22d4-4ce6-970c-10a959831dca" />
        </entry>
    </section>
    <!--  Patient demographics -->
    <section>
        <title value="Patient demographics" />
        <code>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings" />
                <code value="patient-demographics" />
                <display value="Patient demographics" />
            </coding>
        </code>
        <text>
            <status value="generated" />
            <div xmlns="http://www.w3.org/1999/xhtml"><table width="100%"><tbody><tr><th>Patient name</th><td><p>Prefix: Mr</p><p>Given Name: Richard</p><p>Family Name: Smith</p></td></tr><tr><th>Date of birth</th><td>1 January 1957</td></tr><tr><th>Gender</th><td>Male</td></tr><tr><th>NHS number</th><td>1352465790</td></tr><tr><th>Patient address</th><td><p>Address Line: 21, Grove Street, Overtown</p><p>City: Leeds</p><p>Post Code: LS21 1PF</p></td></tr></tbody></table></div>
        </text>
        <!-- reference to further information carried in the patient resource -->
        <entry>
            <reference value="urn:uuid:c8225cc8-8026-466f-80f8-fc2832a4b9d5" />
        </entry>
    </section>
    <!-- Person completing record -->
    <section>
        <title value="Person completing record" />
        <code>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings" />
                <code value="person-completing-record" />
                <display value="Person completing record" />
            </coding>
        </code>
        <text>
            <status value="generated" />
            <div xmlns="http://www.w3.org/1999/xhtml"><table width="100%"><tbody><tr><th>Name</th><td><p>Prefix: Dr</p><p>Given Name: Paul</p><p>Family Name: Rastall</p></td></tr></tbody></table></div>
        </text>
        <!-- Reference to the practitioner entry as the source of information for this section -->
        <entry>
            <reference value="urn:uuid:369d88a8-9f6b-407f-8560-6ee9d7ccc8bb" />
        </entry>
    </section>
    <!-- Plan and requested actions -->
    <section>
        <title value="Plan and requested actions" />
        <code>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings" />
                <code value="plan-and-requested-actions" />
                <display value="Plan and requested actions" />
            </coding>
        </code>
        <text>
            <status value="additional" />
            <div xmlns="http://www.w3.org/1999/xhtml"><table width="100%"><tbody><tr><th>Action</th><td><p>Patient has agreed to be admitted to Cramer ward for further tests to investigate causes of 
his chest pain on 12 February 2015.</p><p>Person responsible: Dr. Paul Rastall (Accident and Emergency Consultant, St. James's 
University Hospital Accident and Emergency Department)</p><p>Status: Completed</p><p>Outcome: Patient expects to find out the more information about the reasons for his 
chest pain when tests are carried out after admission.</p></td></tr></tbody></table></div>
        </text>
    </section>
    <!-- Presenting complaints or issues -->
    <section>
        <title value="Presenting complaints or issues" />
        <code>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings" />
                <code value="presenting-complaints-or-issues" />
                <display value="Presenting complaints or issues" />
            </coding>
        </code>
        <text>
            <status value="generated" />
            <div xmlns="http://www.w3.org/1999/xhtml"><table width="100%"><tbody><tr><th>Presenting complaints or issue</th><td>Chest pain</td></tr></tbody></table></div>
        </text>
        <!-- Reference to information in the Condition list resource -->
        <entry>
            <reference value="urn:uuid:0a46351b-bfe1-4085-956e-15d3b172e36f" />
        </entry>
    </section>
    <!-- Procedures -->
    <section>
        <title value="Procedures" />
        <code>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings" />
                <code value="procedures" />
                <display value="Procedures" />
            </coding>
        </code>
        <text>
            <status value="additional" />
            <div xmlns="http://www.w3.org/1999/xhtml"><table><tbody><tr><th>Procedure name</th><td>Electrocardiographic monitoring</td></tr><tr><th>Comment</th><td>ECGs showed inferior ischaemic changes.</td></tr></tbody></table></div>
        </text>
        <!-- reference to further information carried in the procedure list resource -->
        <entry>
            <reference value="urn:uuid:1e04ce96-6e52-4f82-bc26-93c89c5836a1" />
        </entry>
    </section>
    <!-- Referrer details -->
    <section>
        <title value="Referrer details" />
        <code>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings" />
                <code value="referrer-details" />
                <display value="Referrer details" />
            </coding>
        </code>
        <text>
            <status value="additional" />
            <div xmlns="http://www.w3.org/1999/xhtml"><table width="100%"><tbody><tr><th>Referrer details</th><td>Self-referral to accident and emergency department</td></tr></tbody></table></div>
        </text>
    </section>
    <!-- Senior reviewing clinician -->
    <section>
        <title value="Senior reviewing clinician" />
        <code>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings" />
                <code value="senior-reviewing-clinician" />
                <display value="Senior reviewing clinician" />
            </coding>
        </code>
        <text>
            <status value="generated" />
            <div xmlns="http://www.w3.org/1999/xhtml"><table width="100%"><tbody><tr><th>Name</th><td><p>Prefix: Mr</p><p>Family Name: Abacus</p></td></tr></tbody></table></div>
        </text>
        <!-- reference to further information carried in the practitioner resource -->
        <entry>
            <reference value="urn:uuid:d25fd1c6-2658-4db7-9af0-86c5f95e8ec9" />
        </entry>
    </section>
</Composition>

JSON View

{
    "resourceType": "Composition",
    "id": "UKCore-Composition-Discharge-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "310000008",
                        "display": "Accident and Emergency service"
                    }
                ]
            }
        }
    ],
    "identifier": {
        "system": "https://tools.ietf.org/html/rfc4122",
        "value": "2d361270-039f-4a48-827b-ef255ff8b6c4"
    },
    "status": "final",
    "type": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "373942005",
                "display": "Discharge summary"
            }
        ]
    },
    "subject": {
        "reference": "urn:uuid:c8225cc8-8026-466f-80f8-fc2832a4b9d5"
    },
    "encounter": {
        "reference": "urn:uuid:9a20cb92-354a-4015-82ec-ab0252efc5b9"
    },
    "date": "2021-02-12T19:00:00+00:00",
    "author":  [
        {
            "reference": "urn:uuid:369d88a8-9f6b-407f-8560-6ee9d7ccc8bb"
        }
    ],
    "title": "Accident & Emergency Discharge summary",
    "custodian": {
        "reference": "urn:uuid:120633ae-1a20-4e0e-b807-b78fb59679cc"
    },
    "section":  [
        {
            "title": "Allergies and adverse reaction",
            "code": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings",
                        "code": "allergies-and-adverse-reaction",
                        "display": "Allergies and adverse reaction"
                    }
                ]
            },
            "text": {
                "status": "additional",
                "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table width=\"100%\"><tbody><tr><th>Causative agent</th><td>Penicillin -class of antibiotic</td></tr><tr><th>Description of reaction</th><td>Eruption due to drug</td></tr><tr><th>Severity</th><td>Mild</td></tr><tr><th>Certainty</th><td>Certain</td></tr><tr><th>Comment</th><td>No swelling</td></tr></tbody></table></div>"
            },
            "entry":  [
                {
                    "reference": "urn:uuid:b37c89af-c5da-425f-8e6d-58c043ccf94b"
                }
            ]
        },
        {
            "title": "Attendance details",
            "code": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings",
                        "code": "attendance-details",
                        "display": "Attendance details"
                    }
                ]
            },
            "text": {
                "status": "additional",
                "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table width=\"100%\"><tbody><tr><th>Date and time of contact</th><td>12-Feb-2015 07:00</td></tr></tbody></table></div>"
            }
        },
        {
            "title": "Clinical narrative",
            "code": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings",
                        "code": "clinical-narrative",
                        "display": "Clinical narrative"
                    }
                ]
            },
            "text": {
                "status": "additional",
                "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table width=\"100%\"><tbody><tr><th>Clinical narrative</th></tr><tr><td><p>60 year old man complaining of chest pain lasting around 2 hours.</p><p>Examination unremarkable.</p><p>Inferior ischaemic changes on ECG.</p></td></tr></tbody></table><table><tbody><tr><td><pre>\nFull Blood Count \n\nTestValueUnitsReference Range\nWhite Cell Count11.1x10*9/L3.5 - 10.0\nRed Cell Count5.0x10*12/L4.25 - 5.75 \nHaemoglobin150g/L13.0 - 17.0\nHaematocrit0.230L/L0.400 - 0.500\nMean Cell Volume90fL84 - 98\nMean Cell Hb33.0pg27.5 - 32.0\nMean Cell Hb Con34.0pg31.0 - 35.0\nRDW12.0%&lt; 14.5\nPlatelet Count300x10*9/L150 - 400\n\nMachine Differential \n\nTestValueUnitsReference Range\nNeutrophils7.0x10*9/L1.7 - 7.5\nLymphocytes3.5x10*9/L1.0 - 3.5\nMonocytes0.3x10*9/L&lt; 0.6\nEosinophils0.4x10*9/L&lt; 0.4\nBasophils0.1x10*9/L&lt; 0.1\nLUCs0.2x10*9/L&lt; 0.4\n                                </pre></td></tr></tbody></table></div>"
            }
        },
        {
            "title": "Contact for further information",
            "code": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings",
                        "code": "contact-for-further-information",
                        "display": "Contact for further information"
                    }
                ]
            },
            "text": {
                "status": "additional",
                "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table width=\"100%\"><tbody><tr><th>Contact for further information</th><td>Dr Paul Rastall Tel: 0113 6323200</td></tr></tbody></table></div>"
            }
        },
        {
            "title": "Diagnoses",
            "code": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings",
                        "code": "diagnoses",
                        "display": "Diagnoses"
                    }
                ]
            },
            "text": {
                "status": "generated",
                "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table width=\"100%\"><tbody><tr><th>Diagnosis name</th><td>Acute ST segment elevation myocardial infarction</td></tr></tbody></table></div>"
            },
            "entry":  [
                {
                    "reference": "urn:uuid:0a46351b-bfe1-4085-956e-15d3b172e36f"
                }
            ]
        },
        {
            "title": "Discharge details",
            "code": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings",
                        "code": "discharge-details",
                        "display": "Discharge details"
                    }
                ]
            },
            "text": {
                "status": "extensions",
                "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table width=\"100%\"><tbody><tr><th>Discharge status</th><td>Streamed from emergency department to urgent care service following initial assessment</td></tr><tr><th>Date/time of discharge</th><td>12-Feb-2015 08:00</td></tr><tr><th>Discharge destination</th><td>NHS other Hospital Provider - Ward for general Patients or the younger physically disabled</td></tr></tbody></table></div>"
            },
            "entry":  [
                {
                    "reference": "urn:uuid:9a20cb92-354a-4015-82ec-ab0252efc5b9"
                }
            ]
        },
        {
            "title": "GP practice",
            "code": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings",
                        "code": "general-practitioner-practice",
                        "display": "General practitioner practice"
                    }
                ]
            },
            "text": {
                "status": "additional",
                "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table width=\"100%\"><tbody><tr><th>GP name</th><td><p>Prefix: Dr</p><p>Given Name: John</p><p>Family Name: Lorenzo</p></td></tr><tr><th>GP practice details</th><td><p>Name: MGP Medical Centre</p><p>Address:</p><p>Address Line: 1 MGP House, Overtown</p><p>City: Leeds</p><p>Post Code: LS21 7PA</p></td></tr></tbody></table></div>"
            },
            "entry":  [
                {
                    "reference": "urn:uuid:e4058bb2-bf1a-47a4-ab10-1471161380a1"
                }
            ]
        },
        {
            "title": "Information and advice given",
            "code": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings",
                        "code": "information-and-advice-given",
                        "display": "Information and advice given"
                    }
                ]
            },
            "text": {
                "status": "additional",
                "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table width=\"100%\"><tbody><tr><th>Information and advice given</th><td>Patient advised to be admitted to ward for further tests after ECG results \nshowed inferior ischaemic changes.</td></tr></tbody></table></div>"
            }
        },
        {
            "title": "Medications and medical devices",
            "code": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings",
                        "code": "medications-and-medical-devices",
                        "display": "Medications and medical devices"
                    }
                ]
            },
            "text": {
                "status": "additional",
                "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table width=\"100%\"><tbody><tr><th>Medication name</th><td>Ramipril 2.5mg tablets (A A H Pharmaceuticals Ltd)</td></tr><tr><th>Form</th><td>Tablet</td></tr><tr><th>Route</th><td>Oral</td></tr><tr><th>Dose directions description</th><td>One 2.5mg tablet once a day.</td></tr><tr><th>Status</th><td>Continued</td></tr></tbody></table><table width=\"100%\"><tbody><tr><th>Medication name</th><td>Aspirin 75mg tablets (Sigma Pharmaceuticals Plc)</td></tr><tr><th>Form</th><td>Tablet</td></tr><tr><th>Route</th><td>Oral</td></tr><tr><th>Dose directions description</th><td>Take one 75mg tablet once a day.</td></tr><tr><th>Status</th><td>Continued</td></tr></tbody></table><table width=\"100%\"><tbody><tr><th>Medication name</th><td>Simvastatin 40mg tablets (Brown &amp; Burk UK Ltd)</td></tr><tr><th>Form</th><td>Tablet</td></tr><tr><th>Route</th><td>Oral</td></tr><tr><th>Dose directions description</th><td>Take one 40mg tablet once a day.</td></tr><tr><th>Status</th><td>Continued</td></tr></tbody></table><table width=\"100%\"><tbody><tr><th>Medication name</th><td>Bisoprolol 5mg tablets (A A H Pharmaceuticals Ltd)</td></tr><tr><th>Form</th><td>Tablet</td></tr><tr><th>Route</th><td>Oral</td></tr><tr><th>Dose directions description</th><td>Take one 5mg tablet daily.</td></tr><tr><th>Comment/recommendation</th><td>Recommend Uptitrate according to BP and HR</td></tr><tr><th>Status</th><td>Continued</td></tr></tbody></table></div>"
            },
            "entry":  [
                {
                    "reference": "urn:uuid:e3c8b45f-22d4-4ce6-970c-10a959831dca"
                }
            ]
        },
        {
            "title": "Patient demographics",
            "code": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings",
                        "code": "patient-demographics",
                        "display": "Patient demographics"
                    }
                ]
            },
            "text": {
                "status": "generated",
                "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table width=\"100%\"><tbody><tr><th>Patient name</th><td><p>Prefix: Mr</p><p>Given Name: Richard</p><p>Family Name: Smith</p></td></tr><tr><th>Date of birth</th><td>1 January 1957</td></tr><tr><th>Gender</th><td>Male</td></tr><tr><th>NHS number</th><td>1352465790</td></tr><tr><th>Patient address</th><td><p>Address Line: 21, Grove Street, Overtown</p><p>City: Leeds</p><p>Post Code: LS21 1PF</p></td></tr></tbody></table></div>"
            },
            "entry":  [
                {
                    "reference": "urn:uuid:c8225cc8-8026-466f-80f8-fc2832a4b9d5"
                }
            ]
        },
        {
            "title": "Person completing record",
            "code": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings",
                        "code": "person-completing-record",
                        "display": "Person completing record"
                    }
                ]
            },
            "text": {
                "status": "generated",
                "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table width=\"100%\"><tbody><tr><th>Name</th><td><p>Prefix: Dr</p><p>Given Name: Paul</p><p>Family Name: Rastall</p></td></tr></tbody></table></div>"
            },
            "entry":  [
                {
                    "reference": "urn:uuid:369d88a8-9f6b-407f-8560-6ee9d7ccc8bb"
                }
            ]
        },
        {
            "title": "Plan and requested actions",
            "code": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings",
                        "code": "plan-and-requested-actions",
                        "display": "Plan and requested actions"
                    }
                ]
            },
            "text": {
                "status": "additional",
                "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table width=\"100%\"><tbody><tr><th>Action</th><td><p>Patient has agreed to be admitted to Cramer ward for further tests to investigate causes of \nhis chest pain on 12 February 2015.</p><p>Person responsible: Dr. Paul Rastall (Accident and Emergency Consultant, St. James's \nUniversity Hospital Accident and Emergency Department)</p><p>Status: Completed</p><p>Outcome: Patient expects to find out the more information about the reasons for his \nchest pain when tests are carried out after admission.</p></td></tr></tbody></table></div>"
            }
        },
        {
            "title": "Presenting complaints or issues",
            "code": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings",
                        "code": "presenting-complaints-or-issues",
                        "display": "Presenting complaints or issues"
                    }
                ]
            },
            "text": {
                "status": "generated",
                "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table width=\"100%\"><tbody><tr><th>Presenting complaints or issue</th><td>Chest pain</td></tr></tbody></table></div>"
            },
            "entry":  [
                {
                    "reference": "urn:uuid:0a46351b-bfe1-4085-956e-15d3b172e36f"
                }
            ]
        },
        {
            "title": "Procedures",
            "code": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings",
                        "code": "procedures",
                        "display": "Procedures"
                    }
                ]
            },
            "text": {
                "status": "additional",
                "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table><tbody><tr><th>Procedure name</th><td>Electrocardiographic monitoring</td></tr><tr><th>Comment</th><td>ECGs showed inferior ischaemic changes.</td></tr></tbody></table></div>"
            },
            "entry":  [
                {
                    "reference": "urn:uuid:1e04ce96-6e52-4f82-bc26-93c89c5836a1"
                }
            ]
        },
        {
            "title": "Referrer details",
            "code": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings",
                        "code": "referrer-details",
                        "display": "Referrer details"
                    }
                ]
            },
            "text": {
                "status": "additional",
                "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table width=\"100%\"><tbody><tr><th>Referrer details</th><td>Self-referral to accident and emergency department</td></tr></tbody></table></div>"
            }
        },
        {
            "title": "Senior reviewing clinician",
            "code": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-RecordStandardHeadings",
                        "code": "senior-reviewing-clinician",
                        "display": "Senior reviewing clinician"
                    }
                ]
            },
            "text": {
                "status": "generated",
                "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table width=\"100%\"><tbody><tr><th>Name</th><td><p>Prefix: Mr</p><p>Family Name: Abacus</p></td></tr></tbody></table></div>"
            },
            "entry":  [
                {
                    "reference": "urn:uuid:d25fd1c6-2658-4db7-9af0-86c5f95e8ec9"
                }
            ]
        }
    ]
}

An example to illustrate the care setting of a FHIR document

Table View

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

XML View

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

JSON View

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

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

Table View

Condition.id[0]UKCore-Condition-Extension-CodingSCTDescId-Example
Condition.code[0].coding[0].extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescDisplay
Condition.code[0].coding[0].extension[0].valueString[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].valueId[0]301480018
Condition.code[0].coding[0].system[0]http://snomed.info/sct
Condition.code[0].coding[0].code[0]195967001
Condition.code[0].coding[0].display[0]Asthma
Condition.code[0].coding[0].userSelected[0]True
Condition.subject[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example

XML View

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

JSON View

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

An example to illustrate a patient bleeding from ear

Table View

Condition.id[0]UKCore-Condition-BleedingFromEar-Example
Condition.clinicalStatus[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/condition-clinical
Condition.clinicalStatus[0].coding[0].code[0]active
Condition.clinicalStatus[0].coding[0].display[0]Active
Condition.verificationStatus[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/condition-ver-status
Condition.verificationStatus[0].coding[0].code[0]confirmed
Condition.verificationStatus[0].coding[0].display[0]Confirmed
Condition.category[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/condition-category
Condition.category[0].coding[0].code[0]encounter-diagnosis
Condition.category[0].coding[0].display[0]Encounter Diagnosis
Condition.code[0].coding[0].system[0]http://snomed.info/sct
Condition.code[0].coding[0].code[0]26322001
Condition.code[0].coding[0].display[0]Bleeding from ear
Condition.subject[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example

XML View

<Condition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Condition-BleedingFromEar-Example" />
    <clinicalStatus>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/condition-clinical" />
            <code value="active" />
            <display value="Active" />
        </coding>
    </clinicalStatus>
    <verificationStatus>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/condition-ver-status" />
            <code value="confirmed" />
            <display value="Confirmed" />
        </coding>
    </verificationStatus>
    <category>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/condition-category" />
            <code value="encounter-diagnosis" />
            <display value="Encounter Diagnosis" />
        </coding>
    </category>
    <code>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="26322001" />
            <display value="Bleeding from ear" />
        </coding>
    </code>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
</Condition>

JSON View

{
    "resourceType": "Condition",
    "id": "UKCore-Condition-BleedingFromEar-Example",
    "clinicalStatus": {
        "coding":  [
            {
                "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
                "code": "active",
                "display": "Active"
            }
        ]
    },
    "verificationStatus": {
        "coding":  [
            {
                "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
                "code": "confirmed",
                "display": "Confirmed"
            }
        ]
    },
    "category":  [
        {
            "coding":  [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/condition-category",
                    "code": "encounter-diagnosis",
                    "display": "Encounter Diagnosis"
                }
            ]
        }
    ],
    "code": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "26322001",
                "display": "Bleeding from ear"
            }
        ]
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    }
}

An example to illustrate the extension which is used to indicate the actual problem associated with a condition

Table View

Condition.id[0]UKCore-Condition-Extension-ActualProblem-Example
Condition.extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ActualProblem
Condition.extension[0].valueReference[0].reference[0]Condition/UKCore-Condition-BleedingFromEar-Example
Condition.extension[0].valueReference[0].type[0]Condition
Condition.subject[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example

XML View

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

JSON View

Command 'json' could not render: File was not found for Condition-Extension-ActualProblem-Example

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

Table View

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

XML View

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

JSON View

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

An example to illustrate the extension which is used to indicate the significance of a problem associated with a condition

Table View

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

XML View

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

JSON View

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

Table View

Condition.id[0]UKCore-Condition-Extension-RelatedClinicalContent-Example
Condition.extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-RelatedClinicalContent
Condition.extension[0].valueReference[0].reference[0]Observation/UKCore-Observation-AwarenessOfDiagnosis-Example
Condition.extension[0].valueReference[0].type[0]Observation
Condition.subject[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example

XML View

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

JSON View

{
    "resourceType": "Condition",
    "id": "UKCore-Condition-Extension-RelatedClinicalContent-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-RelatedClinicalContent",
            "valueReference": {
                "reference": "Observation/UKCore-Observation-AwarenessOfDiagnosis-Example",
                "type": "Observation"
            }
        }
    ],
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    }
}

Table View

Condition.id[0]UKCore-Condition-Extension-RelatedProblemHeader-Example
Condition.extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-RelatedProblemHeader
Condition.extension[0].extension[0].url[0]type
Condition.extension[0].extension[0].valueCode[0]child
Condition.extension[0].extension[1].url[0]target
Condition.extension[0].extension[1].valueReference[0].reference[0]Condition/UKCore-Condition-BleedingFromEar-Example
Condition.extension[0].extension[1].valueReference[0].type[0]Condition
Condition.subject[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example

XML View

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

JSON View

{
    "resourceType": "Condition",
    "id": "UKCore-Condition-Extension-RelatedProblemHeader-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-RelatedProblemHeader",
            "extension":  [
                {
                    "url": "type",
                    "valueCode": "child"
                },
                {
                    "url": "target",
                    "valueReference": {
                        "reference": "Condition/UKCore-Condition-BleedingFromEar-Example",
                        "type": "Condition"
                    }
                }
            ]
        }
    ],
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    }
}

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-Encounter-Extension-AdmissionMethod-Example
Encounter.extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdmissionMethod
Encounter.extension[0].valueCodeableConcept[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-AdmissionMethodEngland
Encounter.extension[0].valueCodeableConcept[0].coding[0].code[0]13
Encounter.extension[0].valueCodeableConcept[0].coding[0].display[0]Elective Admission: Planned
Encounter.status[0]finished
Encounter.class[0].system[0]http://terminology.hl7.org/CodeSystem/v3-ActCode
Encounter.class[0].code[0]IMP
Encounter.class[0].display[0]inpatient encounter

XML View

<Encounter xmlns="http://hl7.org/fhir">
    <id value="UKCore-Encounter-Extension-AdmissionMethod-Example" />
    <!--  **************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**************  -->
    <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-Encounter-Extension-AdmissionMethod-Example",
    "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"
                    }
                ]
            }
        }
    ],
    "status": "finished",
    "class": {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
        "code": "IMP",
        "display": "inpatient encounter"
    }
}

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

Table View

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

XML View

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

JSON View

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

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

Table View

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

XML View

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

JSON View

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

An example to illustrate an inpatient encounter

Table View

Encounter.id[0]UKCore-Encounter-InpatientEncounter-Example
Encounter.extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdmissionMethod
Encounter.extension[0].valueCodeableConcept[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-AdmissionMethodEngland
Encounter.extension[0].valueCodeableConcept[0].coding[0].code[0]13
Encounter.extension[0].valueCodeableConcept[0].coding[0].display[0]Elective Admission: Planned
Encounter.extension[1].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DischargeMethod
Encounter.extension[1].valueCodeableConcept[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-DischargeMethodEngland
Encounter.extension[1].valueCodeableConcept[0].coding[0].code[0]1
Encounter.extension[1].valueCodeableConcept[0].coding[0].display[0]Patient discharged on clinical advice or with clinical consent
Encounter.identifier[0].system[0]https://tools.ietf.org/html/rfc4122
Encounter.identifier[0].value[0]6f40cebe-7b55-461d-9d7f-eadb4c065762
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.type[0].coding[0].system[0]http://snomed.info/sct
Encounter.type[0].coding[0].code[0]185212007
Encounter.type[0].coding[0].display[0]Seen in hospital ward
Encounter.subject[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
Encounter.participant[0].type[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/v3-ParticipationType
Encounter.participant[0].type[0].coding[0].code[0]ATND
Encounter.participant[0].type[0].coding[0].display[0]attender
Encounter.participant[0].individual[0].reference[0]Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example
Encounter.period[0].start[0]2019-12-10T13:00:00+00:00
Encounter.period[0].end[0]2019-12-11T13:00:00+00:00
Encounter.reasonCode[0].coding[0].system[0]http://snomed.info/sct
Encounter.reasonCode[0].coding[0].code[0]7922000
Encounter.reasonCode[0].coding[0].display[0]General treatment
Encounter.hospitalization[0].dischargeDisposition[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/NHSDataModelAndDictionary-DischargeDestination
Encounter.hospitalization[0].dischargeDisposition[0].coding[0].code[0]19
Encounter.hospitalization[0].dischargeDisposition[0].coding[0].display[0]Usual place of residence unless listed below, for example, a private dwelling whether owner occupied or owned by Local Authority, housing association or other landlord. This includes wardened accommodation but not residential accommodation where health care is provided. It also includes Patients with no fixed abode.
Encounter.location[0].location[0].reference[0]Location/UKCore-Location-CardiologySJUH-Example
Encounter.serviceProvider[0].reference[0]Organization/UKCore-Organization-LeedsTeachingHospital-Example

XML View

<Encounter xmlns="http://hl7.org/fhir">
    <id value="UKCore-Encounter-InpatientEncounter-Example" />
    <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 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>
    <identifier>
        <system value="https://tools.ietf.org/html/rfc4122" />
        <value value="6f40cebe-7b55-461d-9d7f-eadb4c065762" />
    </identifier>
    <status value="finished" />
    <class>
        <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode" />
        <code value="IMP" />
        <display value="inpatient encounter" />
    </class>
    <type>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="185212007" />
            <display value="Seen in hospital ward" />
        </coding>
    </type>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <participant>
        <type>
            <coding>
                <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType" />
                <code value="ATND" />
                <display value="attender" />
            </coding>
        </type>
        <individual>
            <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" />
        </individual>
    </participant>
    <period>
        <start value="2019-12-10T13:00:00+00:00" />
        <end value="2019-12-11T13:00:00+00:00" />
    </period>
    <reasonCode>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="7922000" />
            <display value="General treatment" />
        </coding>
    </reasonCode>
    <hospitalization>
        <dischargeDisposition>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/NHSDataModelAndDictionary-DischargeDestination" />
                <code value="19" />
                <display value="Usual place of residence unless listed below, for example, a private dwelling whether owner occupied or owned by Local Authority, housing association or other landlord. This includes wardened accommodation but not residential accommodation where health care is provided. It also includes Patients with no fixed abode." />
            </coding>
        </dischargeDisposition>
    </hospitalization>
    <location>
        <location>
            <reference value="Location/UKCore-Location-CardiologySJUH-Example" />
        </location>
    </location>
    <serviceProvider>
        <reference value="Organization/UKCore-Organization-LeedsTeachingHospital-Example" />
    </serviceProvider>
</Encounter>

JSON View

{
    "resourceType": "Encounter",
    "id": "UKCore-Encounter-InpatientEncounter-Example",
    "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"
                    }
                ]
            }
        },
        {
            "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"
                    }
                ]
            }
        }
    ],
    "identifier":  [
        {
            "system": "https://tools.ietf.org/html/rfc4122",
            "value": "6f40cebe-7b55-461d-9d7f-eadb4c065762"
        }
    ],
    "status": "finished",
    "class": {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
        "code": "IMP",
        "display": "inpatient encounter"
    },
    "type":  [
        {
            "coding":  [
                {
                    "system": "http://snomed.info/sct",
                    "code": "185212007",
                    "display": "Seen in hospital ward"
                }
            ]
        }
    ],
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "participant":  [
        {
            "type":  [
                {
                    "coding":  [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                            "code": "ATND",
                            "display": "attender"
                        }
                    ]
                }
            ],
            "individual": {
                "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example"
            }
        }
    ],
    "period": {
        "start": "2019-12-10T13:00:00+00:00",
        "end": "2019-12-11T13:00:00+00:00"
    },
    "reasonCode":  [
        {
            "coding":  [
                {
                    "system": "http://snomed.info/sct",
                    "code": "7922000",
                    "display": "General treatment"
                }
            ]
        }
    ],
    "hospitalization": {
        "dischargeDisposition": {
            "coding":  [
                {
                    "system": "https://fhir.hl7.org.uk/CodeSystem/NHSDataModelAndDictionary-DischargeDestination",
                    "code": "19",
                    "display": "Usual place of residence unless listed below, for example, a private dwelling whether owner occupied or owned by Local Authority, housing association or other landlord. This includes wardened accommodation but not residential accommodation where health care is provided. It also includes Patients with no fixed abode."
                }
            ]
        }
    },
    "location":  [
        {
            "location": {
                "reference": "Location/UKCore-Location-CardiologySJUH-Example"
            }
        }
    ],
    "serviceProvider": {
        "reference": "Organization/UKCore-Organization-LeedsTeachingHospital-Example"
    }
}

Table View

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

XML View

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

JSON View

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

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

Table View

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

XML View

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

JSON View

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

An example to illustrate an episode of care for smoking cessation therapy

Table View

EpisodeOfCare.id[0]UKCore-EpisodeOfCare-SmokingCessationTherapy-Example
EpisodeOfCare.status[0]finished
EpisodeOfCare.type[0].coding[0].system[0]http://snomed.info/sct
EpisodeOfCare.type[0].coding[0].code[0]710081004
EpisodeOfCare.type[0].coding[0].display[0]Smoking cessation therapy
EpisodeOfCare.patient[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
EpisodeOfCare.managingOrganization[0].reference[0]Organization/UKCore-Organization-LeedsTeachingHospital-Example

XML View

<EpisodeOfCare xmlns="http://hl7.org/fhir">
    <id value="UKCore-EpisodeOfCare-SmokingCessationTherapy-Example" />
    <status value="finished" />
    <type>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="710081004" />
            <display value="Smoking cessation therapy" />
        </coding>
    </type>
    <patient>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </patient>
    <managingOrganization>
        <reference value="Organization/UKCore-Organization-LeedsTeachingHospital-Example" />
    </managingOrganization>
</EpisodeOfCare>

JSON View

{
    "resourceType": "EpisodeOfCare",
    "id": "UKCore-EpisodeOfCare-SmokingCessationTherapy-Example",
    "status": "finished",
    "type":  [
        {
            "coding":  [
                {
                    "system": "http://snomed.info/sct",
                    "code": "710081004",
                    "display": "Smoking cessation therapy"
                }
            ]
        }
    ],
    "patient": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "managingOrganization": {
        "reference": "Organization/UKCore-Organization-LeedsTeachingHospital-Example"
    }
}

An example to illustrate a vaccination for Flu

Table View

Immunization.id[0]UKCore-Immunization-InfluenzaVaccine-Example
Immunization.status[0]completed
Immunization.vaccineCode[0].coding[0].system[0]https://dmd.nhs.uk
Immunization.vaccineCode[0].coding[0].code[0]11278411000001109
Immunization.vaccineCode[0].coding[0].display[0]Influenza vaccine (split virion, inactivated) suspension for injection 0.5ml pre-filled syringes (Pfizer Ltd)
Immunization.patient[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
Immunization.occurrenceDateTime[0]2013-01-10
Immunization.location[0].reference[0]UKCore-Location-GeneralPracticeNurseClinic-Example

XML View

<Immunization xmlns="http://hl7.org/fhir">
    <id value="UKCore-Immunization-InfluenzaVaccine-Example" />
    <status value="completed" />
    <vaccineCode>
        <coding>
            <system value="https://dmd.nhs.uk" />
            <code value="11278411000001109" />
            <display value="Influenza vaccine (split virion, inactivated) suspension for injection 0.5ml pre-filled syringes (Pfizer Ltd)" />
        </coding>
    </vaccineCode>
    <patient>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </patient>
    <occurrenceDateTime value="2013-01-10" />
    <location>
        <reference value="UKCore-Location-GeneralPracticeNurseClinic-Example" />
    </location>
</Immunization>

JSON View

{
    "resourceType": "Immunization",
    "id": "UKCore-Immunization-InfluenzaVaccine-Example",
    "status": "completed",
    "vaccineCode": {
        "coding":  [
            {
                "system": "https://dmd.nhs.uk",
                "code": "11278411000001109",
                "display": "Influenza vaccine (split virion, inactivated) suspension for injection 0.5ml pre-filled syringes (Pfizer Ltd)"
            }
        ]
    },
    "patient": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "occurrenceDateTime": "2013-01-10",
    "location": {
        "reference": "UKCore-Location-GeneralPracticeNurseClinic-Example"
    }
}

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

Table View

Immunization.id[0]UKCore-Immunization-Extension-ParentPresent-Example
Immunization.extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ParentPresent
Immunization.extension[0].valueBoolean[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.occurrenceDateTime[0]2021-07-20

XML View

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

JSON View

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

An example to illustrate the extension for a vaccination procedure

Table View

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

XML View

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

JSON View

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

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

Table View

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

XML View

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

JSON View

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

An example to illustrate an empty list

Table View

List.id[0]UKCore-List-EmptyList-Example
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]2019-12-10T13:00:00+00:00
List.emptyReason[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-ListEmptyReasonCode
List.emptyReason[0].coding[0].code[0]no-content-recorded
List.emptyReason[0].coding[0].display[0]No Content Recorded

XML View

<List xmlns="http://hl7.org/fhir">
    <id value="UKCore-List-EmptyList-Example" />
    <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="2019-12-10T13:00:00+00:00" />
    <emptyReason>
        <coding>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-ListEmptyReasonCode" />
            <code value="no-content-recorded" />
            <display value="No Content Recorded" />
        </coding>
    </emptyReason>
</List>

JSON View

{
    "resourceType": "List",
    "id": "UKCore-List-EmptyList-Example",
    "status": "current",
    "mode": "working",
    "code": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "826501000000100",
                "display": "Miscellaneous record"
            }
        ]
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "date": "2019-12-10T13:00:00+00:00",
    "emptyReason": {
        "coding":  [
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-ListEmptyReasonCode",
                "code": "no-content-recorded",
                "display": "No Content Recorded"
            }
        ]
    }
}

An example to illustrate the extension which is used to indicate warnings that a list may be incomplete as data has been excluded due to confidentiality or may be missing due to data being in transit

Table View

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

XML View

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

JSON View

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

An example to illustrate a general practice nurse clinic location

Table View

Location.id[0]UKCore-Location-GeneralPracticeNurseClinic-Example
Location.identifier[0].system[0]https://fhir.nhs.uk/Id/ods-site-code
Location.identifier[0].value[0]GP8D7
Location.name[0]WhiteRoseNurseClinic
Location.type[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/v3-RoleCode
Location.type[0].coding[0].code[0]GIM
Location.type[0].coding[0].display[0]General internal medicine clinic
Location.telecom[0].system[0]phone
Location.telecom[0].value[0]0113 243 3166
Location.managingOrganization[0].reference[0]Organization/UKCore-Organization-WhiteRoseMedicalCentre-Example

XML View

<Location xmlns="http://hl7.org/fhir">
    <id value="UKCore-Location-GeneralPracticeNurseClinic-Example" />
    <identifier>
        <system value="https://fhir.nhs.uk/Id/ods-site-code" />
        <value value="GP8D7" />
    </identifier>
    <name value="WhiteRoseNurseClinic" />
    <type>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode" />
            <code value="GIM" />
            <display value="General internal medicine clinic" />
        </coding>
    </type>
    <telecom>
        <system value="phone" />
        <value value="0113 243 3166" />
    </telecom>
    <managingOrganization>
        <reference value="Organization/UKCore-Organization-WhiteRoseMedicalCentre-Example" />
    </managingOrganization>
</Location>

JSON View

{
    "resourceType": "Location",
    "id": "UKCore-Location-GeneralPracticeNurseClinic-Example",
    "identifier":  [
        {
            "system": "https://fhir.nhs.uk/Id/ods-site-code",
            "value": "GP8D7"
        }
    ],
    "name": "WhiteRoseNurseClinic",
    "type":  [
        {
            "coding":  [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                    "code": "GIM",
                    "display": "General internal medicine clinic"
                }
            ]
        }
    ],
    "telecom":  [
        {
            "system": "phone",
            "value": "0113 243 3166"
        }
    ],
    "managingOrganization": {
        "reference": "Organization/UKCore-Organization-WhiteRoseMedicalCentre-Example"
    }
}

An example to illustrate a Cardiology SJUH location

Table View

Location.id[0]UKCore-Location-CardiologySJUH-Example
Location.identifier[0].system[0]https://fhir.nhs.uk/Id/ods-site-code
Location.identifier[0].value[0]RR8D7
Location.name[0]CARDIOLOGY SJUH
Location.type[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/v3-RoleCode
Location.type[0].coding[0].code[0]CARD
Location.type[0].coding[0].display[0]Ambulatory Health Care Facilities; Clinic/Center; Rehabilitation: Cardiac Facilities
Location.telecom[0].system[0]phone
Location.telecom[0].value[0]0113 243 3149
Location.address[0].line[0]CARDIOLOGY SJUH
Location.address[0].line[1]ST. JAMES'S UNIVERSITY HOSPITAL
Location.address[0].line[2]BECKETT STREET
Location.address[0].city[0]LEEDS
Location.address[0].postalCode[0]LS9 7TF
Location.address[0].country[0]ENGLAND
Location.managingOrganization[0].reference[0]Organization/UKCore-Organization-LeedsTeachingHospital-Example

XML View

<Location xmlns="http://hl7.org/fhir">
    <id value="UKCore-Location-CardiologySJUH-Example" />
    <identifier>
        <system value="https://fhir.nhs.uk/Id/ods-site-code" />
        <value value="RR8D7" />
    </identifier>
    <name value="CARDIOLOGY SJUH" />
    <type>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode" />
            <code value="CARD" />
            <display value="Ambulatory Health Care Facilities; Clinic/Center; Rehabilitation: Cardiac Facilities" />
        </coding>
    </type>
    <telecom>
        <system value="phone" />
        <value value="0113 243 3149" />
    </telecom>
    <address>
        <line value="CARDIOLOGY SJUH" />
        <line value="ST. JAMES&#39;S UNIVERSITY HOSPITAL" />
        <line value="BECKETT STREET" />
        <city value="LEEDS" />
        <postalCode value="LS9 7TF" />
        <country value="ENGLAND" />
    </address>
    <managingOrganization>
        <reference value="Organization/UKCore-Organization-LeedsTeachingHospital-Example" />
    </managingOrganization>
</Location>

JSON View

{
    "resourceType": "Location",
    "id": "UKCore-Location-CardiologySJUH-Example",
    "identifier":  [
        {
            "system": "https://fhir.nhs.uk/Id/ods-site-code",
            "value": "RR8D7"
        }
    ],
    "name": "CARDIOLOGY SJUH",
    "type":  [
        {
            "coding":  [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                    "code": "CARD",
                    "display": "Ambulatory Health Care Facilities; Clinic/Center; Rehabilitation: Cardiac Facilities"
                }
            ]
        }
    ],
    "telecom":  [
        {
            "system": "phone",
            "value": "0113 243 3149"
        }
    ],
    "address": {
        "line":  [
            "CARDIOLOGY SJUH",
            "ST. JAMES'S UNIVERSITY HOSPITAL",
            "BECKETT STREET"
        ],
        "city": "LEEDS",
        "postalCode": "LS9 7TF",
        "country": "ENGLAND"
    },
    "managingOrganization": {
        "reference": "Organization/UKCore-Organization-LeedsTeachingHospital-Example"
    }
}

An example to illustrate Timoptol eye drops medication

Table View

Medication.id[0]UKCore-Medication-TimoptolEyeDrops-Example
Medication.code[0].coding[0].system[0]https://dmd.nhs.uk
Medication.code[0].coding[0].code[0]18616211000001106
Medication.code[0].coding[0].display[0]Timoptol 0.5% eye drops (DE Pharmaceuticals)

XML View

<Medication xmlns="http://hl7.org/fhir">
    <id value="UKCore-Medication-TimoptolEyeDrops-Example" />
    <code>
        <coding>
            <system value="https://dmd.nhs.uk" />
            <code value="18616211000001106" />
            <display value="Timoptol 0.5% eye drops (DE Pharmaceuticals)" />
        </coding>
    </code>
</Medication>

JSON View

{
    "resourceType": "Medication",
    "id": "UKCore-Medication-TimoptolEyeDrops-Example",
    "code": {
        "coding":  [
            {
                "system": "https://dmd.nhs.uk",
                "code": "18616211000001106",
                "display": "Timoptol 0.5% eye drops (DE Pharmaceuticals)"
            }
        ]
    }
}

An example to illustrate use of Medication Trade Family Extension

Table View

Medication.id[0]UKCore-Medication-Extension-MedicationTradeFamily-Example
Medication.extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily
Medication.extension[0].valueCodeableConcept[0].coding[0].system[0]http://snomed.info/sct
Medication.extension[0].valueCodeableConcept[0].coding[0].code[0]9298001000001101
Medication.extension[0].valueCodeableConcept[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 (GlaxoSmithKline Consumer Healthcare UK Ltd)

XML View

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

JSON View

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

An example to illustrate an administration of Timoptol eye drops

Table View

MedicationAdministration.id[0]UKCore-MedicationAdministration-TimoptolEyeDrops-Example
MedicationAdministration.identifier[0].system[0]https://tools.ietf.org/html/rfc4122
MedicationAdministration.identifier[0].value[0]e8779393-9b7c-4654-a8df-0ba4cc9b28ce
MedicationAdministration.status[0]completed
MedicationAdministration.medicationReference[0].reference[0]Medication/UKCore-Medication-TimoptolEyeDrops-Example
MedicationAdministration.subject[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
MedicationAdministration.effectiveDateTime[0]2021-03-25T13:00:00+00:00
MedicationAdministration.request[0].reference[0]MedicationRequest/UKCore-MedicationRequest-EyeDrops-Example
MedicationAdministration.dosage[0].text[0]1 drop in each affected eye twice daily, approximately 12 hours apart.
MedicationAdministration.dosage[0].site[0].coding[0].system[0]http://snomed.info/sct
MedicationAdministration.dosage[0].site[0].coding[0].code[0]362508001
MedicationAdministration.dosage[0].site[0].coding[0].display[0]Both eyes, entire
MedicationAdministration.dosage[0].route[0].coding[0].system[0]http://snomed.info/sct
MedicationAdministration.dosage[0].route[0].coding[0].code[0]58831000052108
MedicationAdministration.dosage[0].route[0].coding[0].display[0]Subretinal route
MedicationAdministration.dosage[0].method[0].coding[0].system[0]http://snomed.info/sct
MedicationAdministration.dosage[0].method[0].coding[0].code[0]421984009
MedicationAdministration.dosage[0].method[0].coding[0].display[0]Until finished
MedicationAdministration.dosage[0].dose[0].value[0]30
MedicationAdministration.dosage[0].dose[0].unit[0]milliliter
MedicationAdministration.dosage[0].dose[0].system[0]http://unitsofmeasure.org
MedicationAdministration.dosage[0].dose[0].code[0]mL

XML View

<MedicationAdministration xmlns="http://hl7.org/fhir">
    <id value="UKCore-MedicationAdministration-TimoptolEyeDrops-Example" />
    <identifier>
        <system value="https://tools.ietf.org/html/rfc4122" />
        <value value="e8779393-9b7c-4654-a8df-0ba4cc9b28ce" />
    </identifier>
    <status value="completed" />
    <medicationReference>
        <reference value="Medication/UKCore-Medication-TimoptolEyeDrops-Example" />
    </medicationReference>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <effectiveDateTime value="2021-03-25T13:00:00+00:00" />
    <request>
        <reference value="MedicationRequest/UKCore-MedicationRequest-EyeDrops-Example" />
    </request>
    <dosage>
        <text value="1 drop in each affected eye twice daily, approximately 12 hours apart." />
        <site>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="362508001" />
                <display value="Both eyes, entire" />
            </coding>
        </site>
        <route>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="58831000052108" />
                <display value="Subretinal route" />
            </coding>
        </route>
        <method>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="421984009" />
                <display value="Until finished" />
            </coding>
        </method>
        <dose>
            <value value="30" />
            <unit value="milliliter" />
            <system value="http://unitsofmeasure.org" />
            <code value="mL" />
        </dose>
    </dosage>
</MedicationAdministration>

JSON View

{
    "resourceType": "MedicationAdministration",
    "id": "UKCore-MedicationAdministration-TimoptolEyeDrops-Example",
    "identifier":  [
        {
            "system": "https://tools.ietf.org/html/rfc4122",
            "value": "e8779393-9b7c-4654-a8df-0ba4cc9b28ce"
        }
    ],
    "status": "completed",
    "medicationReference": {
        "reference": "Medication/UKCore-Medication-TimoptolEyeDrops-Example"
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "effectiveDateTime": "2021-03-25T13:00:00+00:00",
    "request": {
        "reference": "MedicationRequest/UKCore-MedicationRequest-EyeDrops-Example"
    },
    "dosage": {
        "text": "1 drop in each affected eye twice daily, approximately 12 hours apart.",
        "site": {
            "coding":  [
                {
                    "system": "http://snomed.info/sct",
                    "code": "362508001",
                    "display": "Both eyes, entire"
                }
            ]
        },
        "route": {
            "coding":  [
                {
                    "system": "http://snomed.info/sct",
                    "code": "58831000052108",
                    "display": "Subretinal route"
                }
            ]
        },
        "method": {
            "coding":  [
                {
                    "system": "http://snomed.info/sct",
                    "code": "421984009",
                    "display": "Until finished"
                }
            ]
        },
        "dose": {
            "value": 30,
            "unit": "milliliter",
            "system": "http://unitsofmeasure.org",
            "code": "mL"
        }
    }
}

An example to illustrate a medication dispense of eye drops

Table View

MedicationDispense.id[0]UKCore-MedicationDispense-EyeDrops-Example
MedicationDispense.identifier[0].system[0]https://tools.ietf.org/html/rfc4122
MedicationDispense.identifier[0].value[0]5c92c1dc-06a9-4729-b8c9-222cf769f8dc
MedicationDispense.status[0]in-progress
MedicationDispense.medicationReference[0].reference[0]Medication/UKCore-Medication-TimoptolEyeDrops-Example
MedicationDispense.subject[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
MedicationDispense.performer[0].actor[0].reference[0]Practitioner/UKCore-Practitioner-PharmacistJimmyChuck-Example
MedicationDispense.authorizingPrescription[0].reference[0]MedicationRequest/UKCore-MedicationRequest-EyeDrops-Example
MedicationDispense.quantity[0].value[0]30
MedicationDispense.quantity[0].unit[0]milliliter
MedicationDispense.quantity[0].system[0]http://unitsofmeasure.org
MedicationDispense.quantity[0].code[0]mL
MedicationDispense.daysSupply[0].value[0]30
MedicationDispense.daysSupply[0].unit[0]Day
MedicationDispense.daysSupply[0].system[0]http://unitsofmeasure.org
MedicationDispense.daysSupply[0].code[0]d
MedicationDispense.whenPrepared[0]2020-01-15T15:00:00+00:00
MedicationDispense.receiver[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
MedicationDispense.dosageInstruction[0].text[0]1 drop in each affected eye twice daily, approximately 12 hours apart.
MedicationDispense.dosageInstruction[0].timing[0].repeat[0].frequency[0]1
MedicationDispense.dosageInstruction[0].timing[0].repeat[0].period[0]12
MedicationDispense.dosageInstruction[0].timing[0].repeat[0].periodUnit[0]h
MedicationDispense.dosageInstruction[0].site[0].coding[0].system[0]http://snomed.info/sct
MedicationDispense.dosageInstruction[0].site[0].coding[0].code[0]362508001
MedicationDispense.dosageInstruction[0].site[0].coding[0].display[0]Both eyes, entire
MedicationDispense.dosageInstruction[0].route[0].coding[0].system[0]http://snomed.info/sct
MedicationDispense.dosageInstruction[0].route[0].coding[0].code[0]58831000052108
MedicationDispense.dosageInstruction[0].route[0].coding[0].display[0]Subretinal route
MedicationDispense.dosageInstruction[0].method[0].coding[0].system[0]http://snomed.info/sct
MedicationDispense.dosageInstruction[0].method[0].coding[0].code[0]421984009
MedicationDispense.dosageInstruction[0].method[0].coding[0].display[0]Until finished

XML View

<MedicationDispense xmlns="http://hl7.org/fhir">
    <id value="UKCore-MedicationDispense-EyeDrops-Example" />
    <identifier>
        <system value="https://tools.ietf.org/html/rfc4122" />
        <value value="5c92c1dc-06a9-4729-b8c9-222cf769f8dc" />
    </identifier>
    <status value="in-progress" />
    <medicationReference>
        <reference value="Medication/UKCore-Medication-TimoptolEyeDrops-Example" />
    </medicationReference>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <performer>
        <actor>
            <reference value="Practitioner/UKCore-Practitioner-PharmacistJimmyChuck-Example" />
        </actor>
    </performer>
    <authorizingPrescription>
        <reference value="MedicationRequest/UKCore-MedicationRequest-EyeDrops-Example" />
    </authorizingPrescription>
    <quantity>
        <value value="30" />
        <unit value="milliliter" />
        <system value="http://unitsofmeasure.org" />
        <code value="mL" />
    </quantity>
    <daysSupply>
        <value value="30" />
        <unit value="Day" />
        <system value="http://unitsofmeasure.org" />
        <code value="d" />
    </daysSupply>
    <whenPrepared value="2020-01-15T15:00:00+00:00" />
    <receiver>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </receiver>
    <dosageInstruction>
        <text value="1 drop in each affected eye twice daily, approximately 12 hours apart." />
        <timing>
            <repeat>
                <frequency value="1" />
                <period value="12" />
                <periodUnit value="h" />
            </repeat>
        </timing>
        <site>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="362508001" />
                <display value="Both eyes, entire" />
            </coding>
        </site>
        <route>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="58831000052108" />
                <display value="Subretinal route" />
            </coding>
        </route>
        <method>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="421984009" />
                <display value="Until finished" />
            </coding>
        </method>
    </dosageInstruction>
</MedicationDispense>

JSON View

{
    "resourceType": "MedicationDispense",
    "id": "UKCore-MedicationDispense-EyeDrops-Example",
    "identifier":  [
        {
            "system": "https://tools.ietf.org/html/rfc4122",
            "value": "5c92c1dc-06a9-4729-b8c9-222cf769f8dc"
        }
    ],
    "status": "in-progress",
    "medicationReference": {
        "reference": "Medication/UKCore-Medication-TimoptolEyeDrops-Example"
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "performer":  [
        {
            "actor": {
                "reference": "Practitioner/UKCore-Practitioner-PharmacistJimmyChuck-Example"
            }
        }
    ],
    "authorizingPrescription":  [
        {
            "reference": "MedicationRequest/UKCore-MedicationRequest-EyeDrops-Example"
        }
    ],
    "quantity": {
        "value": 30,
        "unit": "milliliter",
        "system": "http://unitsofmeasure.org",
        "code": "mL"
    },
    "daysSupply": {
        "value": 30,
        "unit": "Day",
        "system": "http://unitsofmeasure.org",
        "code": "d"
    },
    "whenPrepared": "2020-01-15T15:00:00+00:00",
    "receiver":  [
        {
            "reference": "Patient/UKCore-Patient-RichardSmith-Example"
        }
    ],
    "dosageInstruction":  [
        {
            "text": "1 drop in each affected eye twice daily, approximately 12 hours apart.",
            "timing": {
                "repeat": {
                    "frequency": 1,
                    "period": 12,
                    "periodUnit": "h"
                }
            },
            "site": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "362508001",
                        "display": "Both eyes, entire"
                    }
                ]
            },
            "route": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "58831000052108",
                        "display": "Subretinal route"
                    }
                ]
            },
            "method": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "421984009",
                        "display": "Until finished"
                    }
                ]
            }
        }
    ]
}

An example to illustrate a medication request for eye drops

Table View

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

XML View

<MedicationRequest xmlns="http://hl7.org/fhir">
    <id value="UKCore-MedicationRequest-EyeDrops-Example" />
    <status value="completed" />
    <intent value="order" />
    <category>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/medicationrequest-category" />
            <code value="outpatient" />
            <display value="Outpatient" />
        </coding>
    </category>
    <priority value="routine" />
    <medicationReference>
        <reference value="Medication/UKCore-Medication-TimoptolEyeDrops-Example" />
    </medicationReference>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <authoredOn value="2022-09-10T15:00:00.000Z" />
    <requester>
        <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" />
    </requester>
    <recorder>
        <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" />
    </recorder>
    <courseOfTherapyType>
        <coding>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-MedicationRequestCourseOfTherapy" />
            <code value="continuous-repeating-dispensing" />
            <display value="Continuous long term (repeat dispensing)" />
        </coding>
    </courseOfTherapyType>
    <dosageInstruction>
        <text value="1 drop in each affected eye twice daily, approximately 12 hours apart." />
        <timing>
            <repeat>
                <frequency value="1" />
                <period value="12" />
                <periodUnit value="h" />
            </repeat>
        </timing>
        <site>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="362508001" />
                <display value="Both eyes, entire" />
            </coding>
        </site>
        <method>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="421984009" />
                <display value="Until finished" />
            </coding>
        </method>
    </dosageInstruction>
    <substitution>
        <allowedBoolean value="true" />
    </substitution>
</MedicationRequest>

JSON View

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

An example to illustrate whether a pharmacist verified a medication

Table View

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

XML View

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

JSON View

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

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

Table View

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

XML View

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

JSON View

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

An example to illustrate a medication statement for Amoxicillin

Table View

MedicationStatement.id[0]UKCore-MedicationStatement-Amoxicillin-Example
MedicationStatement.identifier[0].system[0]https://tools.ietf.org/html/rfc4122
MedicationStatement.identifier[0].value[0]ac0ffbdf-3289-41d5-84d9-068a1f5937db
MedicationStatement.status[0]active
MedicationStatement.category[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/medication-statement-category
MedicationStatement.category[0].coding[0].code[0]outpatient
MedicationStatement.category[0].coding[0].display[0]Outpatient
MedicationStatement.medicationCodeableConcept[0].coding[0].system[0]https://dmd.nhs.uk
MedicationStatement.medicationCodeableConcept[0].coding[0].code[0]39732311000001104
MedicationStatement.medicationCodeableConcept[0].coding[0].display[0]Amoxicillin 250mg capsules
MedicationStatement.subject[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
MedicationStatement.effectivePeriod[0].start[0]2021-02-15T13:50:00+00:00
MedicationStatement.effectivePeriod[0].end[0]2021-05-15T13:50:00+00:00
MedicationStatement.dateAsserted[0]2017-02-22
MedicationStatement.reasonCode[0].coding[0].system[0]http://snomed.info/sct
MedicationStatement.reasonCode[0].coding[0].code[0]65363002
MedicationStatement.reasonCode[0].coding[0].display[0]Otitis media
MedicationStatement.dosage[0].text[0]2 capsules 4 times a day.
MedicationStatement.dosage[0].timing[0].repeat[0].frequency[0]4
MedicationStatement.dosage[0].timing[0].repeat[0].period[0]1
MedicationStatement.dosage[0].timing[0].repeat[0].periodUnit[0]d
MedicationStatement.dosage[0].asNeededCodeableConcept[0].coding[0].system[0]http://snomed.info/sct
MedicationStatement.dosage[0].asNeededCodeableConcept[0].coding[0].code[0]301354004
MedicationStatement.dosage[0].asNeededCodeableConcept[0].coding[0].display[0]Pain of ear
MedicationStatement.dosage[0].site[0].coding[0].system[0]http://snomed.info/sct
MedicationStatement.dosage[0].site[0].coding[0].code[0]123851003
MedicationStatement.dosage[0].site[0].coding[0].display[0]Mouth region structure
MedicationStatement.dosage[0].route[0].coding[0].system[0]http://snomed.info/sct
MedicationStatement.dosage[0].route[0].coding[0].code[0]26643006
MedicationStatement.dosage[0].route[0].coding[0].display[0]Oral
MedicationStatement.dosage[0].method[0].coding[0].system[0]http://snomed.info/sct
MedicationStatement.dosage[0].method[0].coding[0].code[0]421984009
MedicationStatement.dosage[0].method[0].coding[0].display[0]Until finished
MedicationStatement.dosage[0].doseAndRate[0].doseQuantity[0].value[0]500
MedicationStatement.dosage[0].doseAndRate[0].doseQuantity[0].unit[0]milligram
MedicationStatement.dosage[0].doseAndRate[0].doseQuantity[0].system[0]http://unitsofmeasure.org
MedicationStatement.dosage[0].doseAndRate[0].doseQuantity[0].code[0]mg

XML View

<MedicationStatement xmlns="http://hl7.org/fhir">
    <id value="UKCore-MedicationStatement-Amoxicillin-Example" />
    <identifier>
        <system value="https://tools.ietf.org/html/rfc4122" />
        <value value="ac0ffbdf-3289-41d5-84d9-068a1f5937db" />
    </identifier>
    <status value="active" />
    <category>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/medication-statement-category" />
            <code value="outpatient" />
            <display value="Outpatient" />
        </coding>
    </category>
    <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>
    <effectivePeriod>
        <start value="2021-02-15T13:50:00+00:00" />
        <end value="2021-05-15T13:50:00+00:00" />
    </effectivePeriod>
    <dateAsserted value="2017-02-22" />
    <reasonCode>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="65363002" />
            <display value="Otitis media" />
        </coding>
    </reasonCode>
    <dosage>
        <text value="2 capsules 4 times a day." />
        <timing>
            <repeat>
                <frequency value="4" />
                <period value="1" />
                <periodUnit value="d" />
            </repeat>
        </timing>
        <asNeededCodeableConcept>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="301354004" />
                <display value="Pain of ear" />
            </coding>
        </asNeededCodeableConcept>
        <site>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="123851003" />
                <display value="Mouth region structure" />
            </coding>
        </site>
        <route>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="26643006" />
                <display value="Oral" />
            </coding>
        </route>
        <method>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="421984009" />
                <display value="Until finished" />
            </coding>
        </method>
        <doseAndRate>
            <doseQuantity>
                <value value="500" />
                <unit value="milligram" />
                <system value="http://unitsofmeasure.org" />
                <code value="mg" />
            </doseQuantity>
        </doseAndRate>
    </dosage>
</MedicationStatement>

JSON View

{
    "resourceType": "MedicationStatement",
    "id": "UKCore-MedicationStatement-Amoxicillin-Example",
    "identifier":  [
        {
            "system": "https://tools.ietf.org/html/rfc4122",
            "value": "ac0ffbdf-3289-41d5-84d9-068a1f5937db"
        }
    ],
    "status": "active",
    "category": {
        "coding":  [
            {
                "system": "http://terminology.hl7.org/CodeSystem/medication-statement-category",
                "code": "outpatient",
                "display": "Outpatient"
            }
        ]
    },
    "medicationCodeableConcept": {
        "coding":  [
            {
                "system": "https://dmd.nhs.uk",
                "code": "39732311000001104",
                "display": "Amoxicillin 250mg capsules"
            }
        ]
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "effectivePeriod": {
        "start": "2021-02-15T13:50:00+00:00",
        "end": "2021-05-15T13:50:00+00:00"
    },
    "dateAsserted": "2017-02-22",
    "reasonCode":  [
        {
            "coding":  [
                {
                    "system": "http://snomed.info/sct",
                    "code": "65363002",
                    "display": "Otitis media"
                }
            ]
        }
    ],
    "dosage":  [
        {
            "text": "2 capsules 4 times a day.",
            "timing": {
                "repeat": {
                    "frequency": 4,
                    "period": 1,
                    "periodUnit": "d"
                }
            },
            "asNeededCodeableConcept": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "301354004",
                        "display": "Pain of ear"
                    }
                ]
            },
            "site": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "123851003",
                        "display": "Mouth region structure"
                    }
                ]
            },
            "route": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "26643006",
                        "display": "Oral"
                    }
                ]
            },
            "method": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "421984009",
                        "display": "Until finished"
                    }
                ]
            },
            "doseAndRate":  [
                {
                    "doseQuantity": {
                        "value": 500,
                        "unit": "milligram",
                        "system": "http://unitsofmeasure.org",
                        "code": "mg"
                    }
                }
            ]
        }
    ]
}

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

Table View

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

XML View

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

JSON View

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

An example to illustrate 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-MedicationStatement-Extension-PrescribingOrg-Example
MedicationStatement.extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationPrescribingOrganizationType
MedicationStatement.extension[0].valueCodeableConcept[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-MedicationPrescribingOrganizationType
MedicationStatement.extension[0].valueCodeableConcept[0].coding[0].code[0]prescribed-at-gp-practice
MedicationStatement.extension[0].valueCodeableConcept[0].coding[0].display[0]Prescribed at GP practice
MedicationStatement.status[0]active
MedicationStatement.medicationCodeableConcept[0].coding[0].system[0]https://dmd.nhs.uk
MedicationStatement.medicationCodeableConcept[0].coding[0].code[0]39732311000001104
MedicationStatement.medicationCodeableConcept[0].coding[0].display[0]Amoxicillin 250mg capsules
MedicationStatement.subject[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example

XML View

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

JSON View

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

An example to illustrate a message header for a discharge summary

Table View

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

XML View

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

JSON View

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

An example to illustrate the extension which is used to indicate an instruction for a receiver of a message

Table View

MessageHeader.id[0]UKCore-MessageHeader-Extension-MessageHeaderInstruction-Example
MessageHeader.extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MessageHeaderInstruction
MessageHeader.extension[0].valueCoding[0].system[0]http://snomed.info/sct
MessageHeader.extension[0].valueCoding[0].code[0]821301000000103
MessageHeader.extension[0].valueCoding[0].display[0]Liaison with GP (general practitioner)
MessageHeader.eventCoding[0].system[0]http://snomed.info/sct
MessageHeader.eventCoding[0].code[0]306689006
MessageHeader.eventCoding[0].display[0]Discharge to home
MessageHeader.sender[0].reference[0]https://directory.spineservices.nhs.uk/Organization/X26
MessageHeader.source[0].endpoint[0]NOROT003

XML View

<MessageHeader xmlns="http://hl7.org/fhir">
    <id value="UKCore-MessageHeader-Extension-MessageHeaderInstruction-Example" />
    <!--  **************extension start**************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MessageHeaderInstruction">
        <valueCoding>
            <system value="http://snomed.info/sct" />
            <code value="821301000000103" />
            <display value="Liaison with GP (general practitioner)" />
        </valueCoding>
    </extension>
    <!--  *************extension end ***************** -->
    <eventCoding>
        <system value="http://snomed.info/sct" />
        <code value="306689006" />
        <display value="Discharge to home" />
    </eventCoding>
    <sender>
        <reference value="https://directory.spineservices.nhs.uk/Organization/X26" />
    </sender>
    <source>
        <endpoint value="NOROT003" />
    </source>
</MessageHeader>

JSON View

{
    "resourceType": "MessageHeader",
    "id": "UKCore-MessageHeader-Extension-MessageHeaderInstruction-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MessageHeaderInstruction",
            "valueCoding": {
                "system": "http://snomed.info/sct",
                "code": "821301000000103",
                "display": "Liaison with GP (general practitioner)"
            }
        }
    ],
    "eventCoding": {
        "system": "http://snomed.info/sct",
        "code": "306689006",
        "display": "Discharge to home"
    },
    "sender": {
        "reference": "https://directory.spineservices.nhs.uk/Organization/X26"
    },
    "source": {
        "endpoint": "NOROT003"
    }
}

An example to illustrate an error returned due to an error in a date

Table View

OperationOutcome.id[0]UKCore-OperationOutcome-DateError-Example
OperationOutcome.issue[0].severity[0]fatal
OperationOutcome.issue[0].code[0]structure
OperationOutcome.issue[0].details[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/operation-outcome
OperationOutcome.issue[0].details[0].coding[0].code[0]MSG_DATE_FORMAT
OperationOutcome.issue[0].details[0].coding[0].display[0]The Date value %s is not in the correct format (Xml Date Format required)
OperationOutcome.issue[0].diagnostics[0]Interop.FHIRProcessors.Patient.processbirthDate line 2450
OperationOutcome.issue[0].expression[0]Patient.birthDate

XML View

<OperationOutcome xmlns="http://hl7.org/fhir">
    <id value="UKCore-OperationOutcome-DateError-Example" />
    <issue>
        <severity value="fatal" />
        <code value="structure" />
        <details>
            <coding>
                <system value="http://terminology.hl7.org/CodeSystem/operation-outcome" />
                <code value="MSG_DATE_FORMAT" />
                <display value="The Date value %s is not in the correct format (Xml Date Format required)" />
            </coding>
        </details>
        <diagnostics value="Interop.FHIRProcessors.Patient.processbirthDate line 2450" />
        <expression value="Patient.birthDate" />
    </issue>
</OperationOutcome>

JSON View

{
    "resourceType": "OperationOutcome",
    "id": "UKCore-OperationOutcome-DateError-Example",
    "issue":  [
        {
            "severity": "fatal",
            "code": "structure",
            "details": {
                "coding":  [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/operation-outcome",
                        "code": "MSG_DATE_FORMAT",
                        "display": "The Date value %s is not in the correct format (Xml Date Format required)"
                    }
                ]
            },
            "diagnostics": "Interop.FHIRProcessors.Patient.processbirthDate line 2450",
            "expression":  [
                "Patient.birthDate"
            ]
        }
    ]
}

An example to illustrate a general practice organisation

Table View

Organization.id[0]UKCore-Organization-WhiteRoseMedicalCentre-Example
Organization.identifier[0].use[0]official
Organization.identifier[0].system[0]https://fhir.nhs.uk/Id/ods-organization-code
Organization.identifier[0].value[0]GP5
Organization.name[0]WHITE ROSE MEDICAL CENTRE
Organization.telecom[0].system[0]phone
Organization.telecom[0].value[0]0111 243 3144
Organization.address[0].line[0]WHITE ROSE MEDICAL PRACTICE
Organization.address[0].line[1]ROSE STREET
Organization.address[0].city[0]LEEDS
Organization.address[0].postalCode[0]LS1288T
Organization.address[0].country[0]ENGLAND

XML View

<Organization xmlns="http://hl7.org/fhir">
    <id value="UKCore-Organization-WhiteRoseMedicalCentre-Example" />
    <identifier>
        <use value="official" />
        <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
        <value value="GP5" />
    </identifier>
    <name value="WHITE ROSE MEDICAL CENTRE" />
    <telecom>
        <system value="phone" />
        <value value="0111 243 3144" />
    </telecom>
    <address>
        <line value="WHITE ROSE MEDICAL PRACTICE" />
        <line value="ROSE STREET" />
        <city value="LEEDS" />
        <postalCode value="LS1288T" />
        <country value="ENGLAND" />
    </address>
</Organization>

JSON View

{
    "resourceType": "Organization",
    "id": "UKCore-Organization-WhiteRoseMedicalCentre-Example",
    "identifier":  [
        {
            "use": "official",
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "GP5"
        }
    ],
    "name": "WHITE ROSE MEDICAL CENTRE",
    "telecom":  [
        {
            "system": "phone",
            "value": "0111 243 3144"
        }
    ],
    "address":  [
        {
            "line":  [
                "WHITE ROSE MEDICAL PRACTICE",
                "ROSE STREET"
            ],
            "city": "LEEDS",
            "postalCode": "LS1288T",
            "country": "ENGLAND"
        }
    ]
}

An example to illustrate a hospital organisation

Table View

Organization.id[0]UKCore-Organization-LeedsTeachingHospital-Example
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
Organization.telecom[0].system[0]phone
Organization.telecom[0].value[0]0113 243 3144
Organization.address[0].line[0]ST. JAMES'S UNIVERSITY HOSPITAL
Organization.address[0].line[1]BECKETT STREET
Organization.address[0].city[0]LEEDS
Organization.address[0].postalCode[0]LS9 7TF
Organization.address[0].country[0]ENGLAND

XML View

<Organization xmlns="http://hl7.org/fhir">
    <id value="UKCore-Organization-LeedsTeachingHospital-Example" />
    <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" />
    <telecom>
        <system value="phone" />
        <value value="0113 243 3144" />
    </telecom>
    <address>
        <line value="ST. JAMES&#39;S UNIVERSITY HOSPITAL" />
        <line value="BECKETT STREET" />
        <city value="LEEDS" />
        <postalCode value="LS9 7TF" />
        <country value="ENGLAND" />
    </address>
</Organization>

JSON View

{
    "resourceType": "Organization",
    "id": "UKCore-Organization-LeedsTeachingHospital-Example",
    "identifier":  [
        {
            "use": "official",
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "RR8"
        }
    ],
    "name": "LEEDS TEACHING HOSPITALS NHS TRUST",
    "telecom":  [
        {
            "system": "phone",
            "value": "0113 243 3144"
        }
    ],
    "address":  [
        {
            "line":  [
                "ST. JAMES'S UNIVERSITY HOSPITAL",
                "BECKETT STREET"
            ],
            "city": "LEEDS",
            "postalCode": "LS9 7TF",
            "country": "ENGLAND"
        }
    ]
}

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

Table View

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

XML View

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

JSON View

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

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

Table View

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

XML View

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

JSON View

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

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

This example uses an extension to show the patient's birth sex.

Table View

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

XML View

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

JSON View

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

An example to illustrate a patient called Richard Smith

Table View

Patient.id[0]UKCore-Patient-RichardSmith-Example
Patient.extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory
Patient.extension[0].valueCodeableConcept[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategoryEngland
Patient.extension[0].valueCodeableConcept[0].coding[0].code[0]G
Patient.extension[0].valueCodeableConcept[0].coding[0].display[0]Mixed - Any other mixed background
Patient.extension[1].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference
Patient.extension[1].extension[0].url[0]PreferredContactMethod
Patient.extension[1].extension[0].valueCodeableConcept[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod
Patient.extension[1].extension[0].valueCodeableConcept[0].coding[0].code[0]3
Patient.extension[1].extension[0].valueCodeableConcept[0].coding[0].display[0]Telephone
Patient.extension[1].extension[1].url[0]PreferredContactTimes
Patient.extension[1].extension[1].valueTiming[0].repeat[0].frequency[0]1
Patient.extension[1].extension[1].valueTiming[0].repeat[0].period[0]1
Patient.extension[1].extension[1].valueTiming[0].repeat[0].periodUnit[0]d
Patient.extension[1].extension[1].valueTiming[0].repeat[0].dayOfWeek[0]mon
Patient.extension[1].extension[1].valueTiming[0].repeat[0].dayOfWeek[1]wed
Patient.extension[1].extension[1].valueTiming[0].repeat[0].dayOfWeek[2]fri
Patient.extension[1].extension[1].valueTiming[0].repeat[0].when[0]MORN
Patient.extension[1].extension[2].url[0]PreferredWrittenCommunicationFormat
Patient.extension[1].extension[2].valueCodeableConcept[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat
Patient.extension[1].extension[2].valueCodeableConcept[0].coding[0].code[0]11
Patient.extension[1].extension[2].valueCodeableConcept[0].coding[0].display[0]Large print
Patient.extension[2].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus
Patient.extension[2].extension[0].url[0]deathNotificationStatus
Patient.extension[2].extension[0].valueCodeableConcept[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-DeathNotificationStatus
Patient.extension[2].extension[0].valueCodeableConcept[0].coding[0].code[0]U
Patient.extension[2].extension[0].valueCodeableConcept[0].coding[0].display[0]Removed
Patient.extension[2].extension[1].url[0]systemEffectiveDate
Patient.extension[2].extension[1].valueDateTime[0]2019-08-01T00:00:00.000Z
Patient.extension[3].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus
Patient.extension[3].valueCodeableConcept[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-ResidentialStatus
Patient.extension[3].valueCodeableConcept[0].coding[0].code[0]H
Patient.extension[3].valueCodeableConcept[0].coding[0].display[0]UK Resident
Patient.identifier[0].extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus
Patient.identifier[0].extension[0].valueCodeableConcept[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland
Patient.identifier[0].extension[0].valueCodeableConcept[0].coding[0].code[0]01
Patient.identifier[0].extension[0].valueCodeableConcept[0].coding[0].display[0]Number present and verified
Patient.identifier[0].system[0]https://fhir.nhs.uk/Id/nhs-number
Patient.identifier[0].value[0]9912003888
Patient.name[0].use[0]official
Patient.name[0].family[0]SMITH
Patient.name[0].given[0]Richard
Patient.telecom[0].system[0]phone
Patient.telecom[0].value[0]01131231234
Patient.gender[0]male
Patient.birthDate[0]1970-09-11
Patient.address[0].line[0]4 Sandmoor Drive
Patient.address[0].city[0]LEEDS
Patient.address[0].postalCode[0]LS17 7DF
Patient.contact[0].extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank
Patient.contact[0].extension[0].valuePositiveInt[0]1
Patient.contact[0].extension[1].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
Patient.contact[0].extension[1].valueBoolean[0]True
Patient.contact[0].relationship[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole
Patient.contact[0].relationship[0].coding[0].code[0]Personal
Patient.contact[0].relationship[0].coding[0].display[0]Personal relationship with the patient
Patient.contact[0].name[0].use[0]official
Patient.contact[0].name[0].text[0]JACKSON Jane (Miss)
Patient.contact[0].name[0].family[0]Jackson
Patient.contact[0].name[0].given[0]Jane
Patient.contact[0].name[0].prefix[0]Miss
Patient.contact[0].telecom[0].system[0]phone
Patient.contact[0].telecom[0].value[0]07777123123
Patient.contact[0].telecom[0].use[0]mobile
Patient.contact[0].address[0].use[0]home
Patient.contact[0].address[0].type[0]physical
Patient.contact[0].address[0].line[0]5 Alwoodley Road
Patient.contact[0].address[0].city[0]LEEDS
Patient.contact[0].address[0].postalCode[0]LS17 6EH
Patient.contact[0].gender[0]female
Patient.communication[0].language[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-HumanLanguage
Patient.communication[0].language[0].coding[0].code[0]en
Patient.communication[0].language[0].coding[0].display[0]English

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Patient-RichardSmith-Example" />
    <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="G" />
                <display value="Mixed - Any other mixed background" />
            </coding>
        </valueCodeableConcept>
    </extension>
    <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 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 url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus">
        <valueCodeableConcept>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-ResidentialStatus" />
                <code value="H" />
                <display value="UK Resident" />
            </coding>
        </valueCodeableConcept>
    </extension>
    <identifier>
        <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>
        <system value="https://fhir.nhs.uk/Id/nhs-number" />
        <value value="9912003888" />
    </identifier>
    <name>
        <use value="official" />
        <family value="SMITH" />
        <given value="Richard" />
    </name>
    <telecom>
        <system value="phone" />
        <value value="01131231234" />
    </telecom>
    <gender value="male" />
    <birthDate value="1970-09-11" />
    <address>
        <line value="4 Sandmoor Drive" />
        <city value="LEEDS" />
        <postalCode value="LS17 7DF" />
    </address>
    <contact>
        <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank">
            <valuePositiveInt value="1" />
        </extension>
        <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator">
            <valueBoolean value="true" />
        </extension>
        <relationship>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole" />
                <code value="Personal" />
                <display value="Personal relationship with the patient" />
            </coding>
        </relationship>
        <name>
            <use value="official" />
            <text value="JACKSON Jane (Miss)" />
            <family value="Jackson" />
            <given value="Jane" />
            <prefix value="Miss" />
        </name>
        <telecom>
            <system value="phone" />
            <value value="07777123123" />
            <use value="mobile" />
        </telecom>
        <address>
            <use value="home" />
            <type value="physical" />
            <line value="5 Alwoodley Road" />
            <city value="LEEDS" />
            <postalCode value="LS17 6EH" />
        </address>
        <gender value="female" />
    </contact>
    <communication>
        <language>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-HumanLanguage" />
                <code value="en" />
                <display value="English" />
            </coding>
        </language>
    </communication>
</Patient>

JSON View

{
    "resourceType": "Patient",
    "id": "UKCore-Patient-RichardSmith-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategoryEngland",
                        "code": "G",
                        "display": "Mixed - Any other mixed background"
                    }
                ]
            }
        },
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference",
            "extension":  [
                {
                    "url": "PreferredContactMethod",
                    "valueCodeableConcept": {
                        "coding":  [
                            {
                                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod",
                                "code": "3",
                                "display": "Telephone"
                            }
                        ]
                    }
                },
                {
                    "url": "PreferredContactTimes",
                    "valueTiming": {
                        "repeat": {
                            "frequency": 1,
                            "period": 1,
                            "periodUnit": "d",
                            "dayOfWeek":  [
                                "mon",
                                "wed",
                                "fri"
                            ],
                            "when":  [
                                "MORN"
                            ]
                        }
                    }
                },
                {
                    "url": "PreferredWrittenCommunicationFormat",
                    "valueCodeableConcept": {
                        "coding":  [
                            {
                                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat",
                                "code": "11",
                                "display": "Large print"
                            }
                        ]
                    }
                }
            ]
        },
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus",
            "extension":  [
                {
                    "url": "deathNotificationStatus",
                    "valueCodeableConcept": {
                        "coding":  [
                            {
                                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-DeathNotificationStatus",
                                "code": "U",
                                "display": "Removed"
                            }
                        ]
                    }
                },
                {
                    "url": "systemEffectiveDate",
                    "valueDateTime": "2019-08-01T00:00:00.000Z"
                }
            ]
        },
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-ResidentialStatus",
                        "code": "H",
                        "display": "UK Resident"
                    }
                ]
            }
        }
    ],
    "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"
                            }
                        ]
                    }
                }
            ],
            "system": "https://fhir.nhs.uk/Id/nhs-number",
            "value": "9912003888"
        }
    ],
    "name":  [
        {
            "use": "official",
            "family": "SMITH",
            "given":  [
                "Richard"
            ]
        }
    ],
    "telecom":  [
        {
            "system": "phone",
            "value": "01131231234"
        }
    ],
    "gender": "male",
    "birthDate": "1970-09-11",
    "address":  [
        {
            "line":  [
                "4 Sandmoor Drive"
            ],
            "city": "LEEDS",
            "postalCode": "LS17 7DF"
        }
    ],
    "contact":  [
        {
            "extension":  [
                {
                    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank",
                    "valuePositiveInt": 1
                },
                {
                    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator",
                    "valueBoolean": true
                }
            ],
            "relationship":  [
                {
                    "coding":  [
                        {
                            "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole",
                            "code": "Personal",
                            "display": "Personal relationship with the patient"
                        }
                    ]
                }
            ],
            "name": {
                "use": "official",
                "text": "JACKSON Jane (Miss)",
                "family": "Jackson",
                "given":  [
                    "Jane"
                ],
                "prefix":  [
                    "Miss"
                ]
            },
            "telecom":  [
                {
                    "system": "phone",
                    "value": "07777123123",
                    "use": "mobile"
                }
            ],
            "address": {
                "use": "home",
                "type": "physical",
                "line":  [
                    "5 Alwoodley Road"
                ],
                "city": "LEEDS",
                "postalCode": "LS17 6EH"
            },
            "gender": "female"
        }
    ],
    "communication":  [
        {
            "language": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-HumanLanguage",
                        "code": "en",
                        "display": "English"
                    }
                ]
            }
        }
    ]
}

An example to illustrate a baby patient

Table View

Patient.id[0]UKCore-Patient-BabyPatient-Example
Patient.extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory
Patient.extension[0].valueCodeableConcept[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategoryEngland
Patient.extension[0].valueCodeableConcept[0].coding[0].code[0]A
Patient.extension[0].valueCodeableConcept[0].coding[0].display[0]White - British
Patient.identifier[0].extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus
Patient.identifier[0].extension[0].valueCodeableConcept[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland
Patient.identifier[0].extension[0].valueCodeableConcept[0].coding[0].code[0]01
Patient.identifier[0].extension[0].valueCodeableConcept[0].coding[0].display[0]Number present and verified
Patient.identifier[0].system[0]https://fhir.nhs.uk/Id/nhs-number
Patient.identifier[0].value[0]9912003890
Patient.name[0].use[0]official
Patient.name[0].family[0]JONES
Patient.name[0].given[0]Melanie
Patient.telecom[0].system[0]phone
Patient.telecom[0].value[0]01131231266
Patient.gender[0]female
Patient.birthDate[0]2021-02-11
Patient.birthDate[0].extension[0].url[0]http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.birthDate[0].extension[0].valueDateTime[0]2021-02-11T15:39:00+00:00
Patient.address[0].line[0]10 Fearnville Grove
Patient.address[0].city[0]LEEDS
Patient.address[0].postalCode[0]LS8 3DR

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Patient-BabyPatient-Example" />
    <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>
    <identifier>
        <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>
        <system value="https://fhir.nhs.uk/Id/nhs-number" />
        <value value="9912003890" />
    </identifier>
    <name>
        <use value="official" />
        <family value="JONES" />
        <given value="Melanie" />
    </name>
    <telecom>
        <system value="phone" />
        <value value="01131231266" />
    </telecom>
    <gender value="female" />
    <birthDate value="2021-02-11">
        <extension url="http://hl7.org/fhir/StructureDefinition/patient-birthTime">
            <valueDateTime value="2021-02-11T15:39:00+00:00" />
        </extension>
    </birthDate>
    <address>
        <line value="10 Fearnville Grove" />
        <city value="LEEDS" />
        <postalCode value="LS8 3DR" />
    </address>
</Patient>

JSON View

{
    "resourceType": "Patient",
    "id": "UKCore-Patient-BabyPatient-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategoryEngland",
                        "code": "A",
                        "display": "White - British"
                    }
                ]
            }
        }
    ],
    "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"
                            }
                        ]
                    }
                }
            ],
            "system": "https://fhir.nhs.uk/Id/nhs-number",
            "value": "9912003890"
        }
    ],
    "name":  [
        {
            "use": "official",
            "family": "JONES",
            "given":  [
                "Melanie"
            ]
        }
    ],
    "telecom":  [
        {
            "system": "phone",
            "value": "01131231266"
        }
    ],
    "gender": "female",
    "birthDate": "2021-02-11",
    "_birthDate": {
        "extension":  [
            {
                "url": "http://hl7.org/fhir/StructureDefinition/patient-birthTime",
                "valueDateTime": "2021-02-11T15:39:00+00:00"
            }
        ]
    },
    "address":  [
        {
            "line":  [
                "10 Fearnville Grove"
            ],
            "city": "LEEDS",
            "postalCode": "LS8 3DR"
        }
    ]
}

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

Table View

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

XML View

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

JSON View

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

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

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

Table View

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

XML View

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

JSON View

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

An Example to illustrate the extension for a copy correspondence indicator

This shows the extension that uses a Boolean value of true to indicate that the person named should be sent a copy of the correspondence.

Table View

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

XML View

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

JSON View

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

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

Table View

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

XML View

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

JSON View

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

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

Table View

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

XML View

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

JSON View

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

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

Table View

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

XML View

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

JSON View

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

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

Table View

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

XML View

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

JSON View

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

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

Table View

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

XML View

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

JSON View

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

An example to illustrate a practitioner who is a Pharmacist

Table View

Practitioner.id[0]UKCore-Practitioner-PharmacistJimmyChuck-Example
Practitioner.identifier[0].system[0]https://fhir.nhs.uk/Id/sds-user-id
Practitioner.identifier[0].value[0]P12345678
Practitioner.name[0].family[0]Chuck
Practitioner.name[0].given[0]Jimmy
Practitioner.name[0].prefix[0]Mr
Practitioner.telecom[0].system[0]phone
Practitioner.telecom[0].value[0]0113 6323222
Practitioner.telecom[0].use[0]work
Practitioner.address[0].line[0]INHOUSE PHARMACY
Practitioner.address[0].line[1]ST. JAMES'S UNIVERSITY HOSPITAL
Practitioner.address[0].line[2]BECKETT STREET
Practitioner.address[0].city[0]LEEDS
Practitioner.address[0].postalCode[0]LS9 7TF
Practitioner.address[0].country[0]ENGLAND

XML View

<Practitioner xmlns="http://hl7.org/fhir">
    <id value="UKCore-Practitioner-PharmacistJimmyChuck-Example" />
    <identifier>
        <system value="https://fhir.nhs.uk/Id/sds-user-id" />
        <value value="P12345678" />
    </identifier>
    <name>
        <family value="Chuck" />
        <given value="Jimmy" />
        <prefix value="Mr" />
    </name>
    <telecom>
        <system value="phone" />
        <value value="0113 6323222" />
        <use value="work" />
    </telecom>
    <address>
        <line value="INHOUSE PHARMACY" />
        <line value="ST. JAMES&#39;S UNIVERSITY HOSPITAL" />
        <line value="BECKETT STREET" />
        <city value="LEEDS" />
        <postalCode value="LS9 7TF" />
        <country value="ENGLAND" />
    </address>
</Practitioner>

JSON View

{
    "resourceType": "Practitioner",
    "id": "UKCore-Practitioner-PharmacistJimmyChuck-Example",
    "identifier":  [
        {
            "system": "https://fhir.nhs.uk/Id/sds-user-id",
            "value": "P12345678"
        }
    ],
    "name":  [
        {
            "family": "Chuck",
            "given":  [
                "Jimmy"
            ],
            "prefix":  [
                "Mr"
            ]
        }
    ],
    "telecom":  [
        {
            "system": "phone",
            "value": "0113 6323222",
            "use": "work"
        }
    ],
    "address":  [
        {
            "line":  [
                "INHOUSE PHARMACY",
                "ST. JAMES'S UNIVERSITY HOSPITAL",
                "BECKETT STREET"
            ],
            "city": "LEEDS",
            "postalCode": "LS9 7TF",
            "country": "ENGLAND"
        }
    ]
}

An example to illustrate a practitioner who is a General Practitioner

Table View

Practitioner.id[0]UKCore-Practitioner-DoctorPaulRastall-Example
Practitioner.identifier[0].system[0]https://fhir.nhs.uk/Id/sds-user-id
Practitioner.identifier[0].value[0]G12345678
Practitioner.name[0].family[0]Rastall
Practitioner.name[0].given[0]Paul
Practitioner.name[0].prefix[0]Dr
Practitioner.telecom[0].system[0]phone
Practitioner.telecom[0].value[0]0113 6323200
Practitioner.telecom[0].use[0]work
Practitioner.address[0].use[0]work
Practitioner.address[0].type[0]both
Practitioner.address[0].line[0]Chapel Main Practice
Practitioner.address[0].line[1]22 Brightside Crescent
Practitioner.address[0].city[0]Overtown
Practitioner.address[0].district[0]West Yorkshire
Practitioner.address[0].postalCode[0]LS10 4YU
Practitioner.gender[0]male

XML View

<Practitioner xmlns="http://hl7.org/fhir">
    <id value="UKCore-Practitioner-DoctorPaulRastall-Example" />
    <identifier>
        <system value="https://fhir.nhs.uk/Id/sds-user-id" />
        <value value="G12345678" />
    </identifier>
    <name>
        <family value="Rastall" />
        <given value="Paul" />
        <prefix value="Dr" />
    </name>
    <telecom>
        <system value="phone" />
        <value value="0113 6323200" />
        <use value="work" />
    </telecom>
    <address>
        <use value="work" />
        <type value="both" />
        <line value="Chapel Main Practice" />
        <line value="22 Brightside Crescent" />
        <city value="Overtown" />
        <district value="West Yorkshire" />
        <postalCode value="LS10 4YU" />
    </address>
    <gender value="male" />
</Practitioner>

JSON View

{
    "resourceType": "Practitioner",
    "id": "UKCore-Practitioner-DoctorPaulRastall-Example",
    "identifier":  [
        {
            "system": "https://fhir.nhs.uk/Id/sds-user-id",
            "value": "G12345678"
        }
    ],
    "name":  [
        {
            "family": "Rastall",
            "given":  [
                "Paul"
            ],
            "prefix":  [
                "Dr"
            ]
        }
    ],
    "telecom":  [
        {
            "system": "phone",
            "value": "0113 6323200",
            "use": "work"
        }
    ],
    "address":  [
        {
            "use": "work",
            "type": "both",
            "line":  [
                "Chapel Main Practice",
                "22 Brightside Crescent"
            ],
            "city": "Overtown",
            "district": "West Yorkshire",
            "postalCode": "LS10 4YU"
        }
    ],
    "gender": "male"
}

An example to illustrate a practitioner who is a Consultant

Table View

Practitioner.id[0]UKCore-Practitioner-ConsultantSandraGose-Example
Practitioner.identifier[0].system[0]https://fhir.nhs.uk/Id/sds-user-id
Practitioner.identifier[0].value[0]C12345678
Practitioner.name[0].family[0]Gose
Practitioner.name[0].given[0]Sandra
Practitioner.name[0].prefix[0]Mrs
Practitioner.telecom[0].system[0]phone
Practitioner.telecom[0].value[0]0113 6323211
Practitioner.telecom[0].use[0]work
Practitioner.address[0].line[0]Admissions Department
Practitioner.address[0].line[1]ST. JAMES'S UNIVERSITY HOSPITAL
Practitioner.address[0].line[2]BECKETT STREET
Practitioner.address[0].city[0]LEEDS
Practitioner.address[0].postalCode[0]LS9 7TF
Practitioner.address[0].country[0]ENGLAND
Practitioner.gender[0]female

XML View

<Practitioner xmlns="http://hl7.org/fhir">
    <id value="UKCore-Practitioner-ConsultantSandraGose-Example" />
    <identifier>
        <system value="https://fhir.nhs.uk/Id/sds-user-id" />
        <value value="C12345678" />
    </identifier>
    <name>
        <family value="Gose" />
        <given value="Sandra" />
        <prefix value="Mrs" />
    </name>
    <telecom>
        <system value="phone" />
        <value value="0113 6323211" />
        <use value="work" />
    </telecom>
    <address>
        <line value="Admissions Department" />
        <line value="ST. JAMES&#39;S UNIVERSITY HOSPITAL" />
        <line value="BECKETT STREET" />
        <city value="LEEDS" />
        <postalCode value="LS9 7TF" />
        <country value="ENGLAND" />
    </address>
    <gender value="female" />
</Practitioner>

JSON View

{
    "resourceType": "Practitioner",
    "id": "UKCore-Practitioner-ConsultantSandraGose-Example",
    "identifier":  [
        {
            "system": "https://fhir.nhs.uk/Id/sds-user-id",
            "value": "C12345678"
        }
    ],
    "name":  [
        {
            "family": "Gose",
            "given":  [
                "Sandra"
            ],
            "prefix":  [
                "Mrs"
            ]
        }
    ],
    "telecom":  [
        {
            "system": "phone",
            "value": "0113 6323211",
            "use": "work"
        }
    ],
    "address":  [
        {
            "line":  [
                "Admissions Department",
                "ST. JAMES'S UNIVERSITY HOSPITAL",
                "BECKETT STREET"
            ],
            "city": "LEEDS",
            "postalCode": "LS9 7TF",
            "country": "ENGLAND"
        }
    ],
    "gender": "female"
}

An example to illustrate a practitioner role of General Practitioner

Table View

PractitionerRole.id[0]UKCore-PractitionerRole-GeneralPractitioner-Example
PractitionerRole.identifier[0].system[0]https://fhir.nhs.uk/Id/sds-role-profile-id
PractitionerRole.identifier[0].value[0]100334993514
PractitionerRole.practitioner[0].reference[0]Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example
PractitionerRole.organization[0].reference[0]Organization/UKCore-Organisation-WhiteRoseMedicalCentre-Example
PractitionerRole.code[0].coding[0].system[0]http://snomed.info/sct
PractitionerRole.code[0].coding[0].code[0]62247001
PractitionerRole.code[0].coding[0].display[0]General practitioner
PractitionerRole.specialty[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-PracticeSettingCode
PractitionerRole.specialty[0].coding[0].code[0]600
PractitionerRole.specialty[0].coding[0].display[0]General Medical Practice
PractitionerRole.telecom[0].system[0]phone
PractitionerRole.telecom[0].value[0]0113 6323200
PractitionerRole.telecom[0].use[0]work

XML View

<PractitionerRole xmlns="http://hl7.org/fhir">
    <id value="UKCore-PractitionerRole-GeneralPractitioner-Example" />
    <identifier>
        <system value="https://fhir.nhs.uk/Id/sds-role-profile-id" />
        <value value="100334993514" />
    </identifier>
    <practitioner>
        <reference value="Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example" />
    </practitioner>
    <organization>
        <reference value="Organization/UKCore-Organisation-WhiteRoseMedicalCentre-Example" />
    </organization>
    <code>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="62247001" />
            <display value="General practitioner" />
        </coding>
    </code>
    <specialty>
        <coding>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-PracticeSettingCode" />
            <code value="600" />
            <display value="General Medical Practice" />
        </coding>
    </specialty>
    <telecom>
        <system value="phone" />
        <value value="0113 6323200" />
        <use value="work" />
    </telecom>
</PractitionerRole>

JSON View

{
    "resourceType": "PractitionerRole",
    "id": "UKCore-PractitionerRole-GeneralPractitioner-Example",
    "identifier":  [
        {
            "system": "https://fhir.nhs.uk/Id/sds-role-profile-id",
            "value": "100334993514"
        }
    ],
    "practitioner": {
        "reference": "Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example"
    },
    "organization": {
        "reference": "Organization/UKCore-Organisation-WhiteRoseMedicalCentre-Example"
    },
    "code":  [
        {
            "coding":  [
                {
                    "system": "http://snomed.info/sct",
                    "code": "62247001",
                    "display": "General practitioner"
                }
            ]
        }
    ],
    "specialty":  [
        {
            "coding":  [
                {
                    "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PracticeSettingCode",
                    "code": "600",
                    "display": "General Medical Practice"
                }
            ]
        }
    ],
    "telecom":  [
        {
            "system": "phone",
            "value": "0113 6323200",
            "use": "work"
        }
    ]
}

An example to illustrate a procedure of skin examination

Table View

Procedure.id[0]UKCore-Procedure-ExaminationOfSkin-Example
Procedure.status[0]completed
Procedure.code[0].coding[0].system[0]http://snomed.info/sct
Procedure.code[0].coding[0].code[0]128004
Procedure.code[0].coding[0].display[0]Hand microscope examination of skin
Procedure.subject[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
Procedure.performedDateTime[0]2019-12-10T13:00:00+00:00

XML View

<Procedure xmlns="http://hl7.org/fhir">
    <id value="UKCore-Procedure-ExaminationOfSkin-Example" />
    <status value="completed" />
    <code>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="128004" />
            <display value="Hand microscope examination of skin" />
        </coding>
    </code>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <performedDateTime value="2019-12-10T13:00:00+00:00" />
</Procedure>

JSON View

{
    "resourceType": "Procedure",
    "id": "UKCore-Procedure-ExaminationOfSkin-Example",
    "status": "completed",
    "code": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "128004",
                "display": "Hand microscope examination of skin"
            }
        ]
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "performedDateTime": "2019-12-10T13:00:00+00:00"
}

An example to illustrate the extension which is used to indicate details of any adverse reaction to any anaesthetic agents including local anaesthesia and problematic intubation, transfusion reaction, etc

Table View

Procedure.id[0]UKCore-Procedure-Extension-AnaestheticIssues-Example
Procedure.extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AnaestheticIssues
Procedure.extension[0].valueCodeableConcept[0].coding[0].system[0]http://snomed.info/sct
Procedure.extension[0].valueCodeableConcept[0].coding[0].code[0]292891000
Procedure.extension[0].valueCodeableConcept[0].coding[0].display[0]Chlorhexidine adverse reaction
Procedure.status[0]completed
Procedure.subject[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
Procedure.performedDateTime[0]2019-12-10T13:00:00+00:00

XML View

<Procedure xmlns="http://hl7.org/fhir">
    <id value="UKCore-Procedure-Extension-AnaestheticIssues-Example" />
    <!--  **************extension start**************  -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AnaestheticIssues">
        <valueCodeableConcept>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="292891000" />
                <display value="Chlorhexidine adverse reaction" />
            </coding>
        </valueCodeableConcept>
    </extension>
    <!--  **************extension end**************  -->
    <status value="completed" />
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <performedDateTime value="2019-12-10T13:00:00+00:00" />
</Procedure>

JSON View

{
    "resourceType": "Procedure",
    "id": "UKCore-Procedure-Extension-AnaestheticIssues-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AnaestheticIssues",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "292891000",
                        "display": "Chlorhexidine adverse reaction"
                    }
                ]
            }
        }
    ],
    "status": "completed",
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "performedDateTime": "2019-12-10T13:00:00+00:00"
}

UKCore-RelatedPerson-JoySmith-Example

Table View

RelatedPerson.id[0]UKCore-RelatedPerson-JoySmith-Example
RelatedPerson.extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference
RelatedPerson.extension[0].extension[0].url[0]PreferredContactMethod
RelatedPerson.extension[0].extension[0].valueCodeableConcept[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod
RelatedPerson.extension[0].extension[0].valueCodeableConcept[0].coding[0].code[0]3
RelatedPerson.extension[0].extension[0].valueCodeableConcept[0].coding[0].display[0]Telephone
RelatedPerson.extension[0].extension[1].url[0]PreferredContactTimes
RelatedPerson.extension[0].extension[1].valueTiming[0].repeat[0].frequency[0]1
RelatedPerson.extension[0].extension[1].valueTiming[0].repeat[0].period[0]1
RelatedPerson.extension[0].extension[1].valueTiming[0].repeat[0].periodUnit[0]d
RelatedPerson.extension[0].extension[1].valueTiming[0].repeat[0].dayOfWeek[0]mon
RelatedPerson.extension[0].extension[1].valueTiming[0].repeat[0].dayOfWeek[1]wed
RelatedPerson.extension[0].extension[1].valueTiming[0].repeat[0].dayOfWeek[2]fri
RelatedPerson.extension[0].extension[1].valueTiming[0].repeat[0].when[0]AFT
RelatedPerson.extension[0].extension[2].url[0]PreferredWrittenCommunicationFormat
RelatedPerson.extension[0].extension[2].valueCodeableConcept[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat
RelatedPerson.extension[0].extension[2].valueCodeableConcept[0].coding[0].code[0]11
RelatedPerson.extension[0].extension[2].valueCodeableConcept[0].coding[0].display[0]Large print
RelatedPerson.extension[1].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank
RelatedPerson.extension[1].valuePositiveInt[0]1
RelatedPerson.extension[2].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
RelatedPerson.extension[2].valueBoolean[0]True
RelatedPerson.patient[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
RelatedPerson.relationship[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/v3-RoleCode
RelatedPerson.relationship[0].coding[0].code[0]WIFE
RelatedPerson.relationship[0].coding[0].display[0]wife
RelatedPerson.name[0].use[0]official
RelatedPerson.name[0].family[0]SMITH
RelatedPerson.name[0].given[0]Joy

XML View

<RelatedPerson xmlns="http://hl7.org/fhir">
    <id value="UKCore-RelatedPerson-JoySmith-Example" />
    <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="AFT" />
                </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 url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank">
        <valuePositiveInt value="1" />
    </extension>
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator">
        <valueBoolean value="true" />
    </extension>
    <patient>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </patient>
    <relationship>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode" />
            <code value="WIFE" />
            <display value="wife" />
        </coding>
    </relationship>
    <name>
        <use value="official" />
        <family value="SMITH" />
        <given value="Joy" />
    </name>
</RelatedPerson>

JSON View

{
    "resourceType": "RelatedPerson",
    "id": "UKCore-RelatedPerson-JoySmith-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference",
            "extension":  [
                {
                    "url": "PreferredContactMethod",
                    "valueCodeableConcept": {
                        "coding":  [
                            {
                                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod",
                                "code": "3",
                                "display": "Telephone"
                            }
                        ]
                    }
                },
                {
                    "url": "PreferredContactTimes",
                    "valueTiming": {
                        "repeat": {
                            "frequency": 1,
                            "period": 1,
                            "periodUnit": "d",
                            "dayOfWeek":  [
                                "mon",
                                "wed",
                                "fri"
                            ],
                            "when":  [
                                "AFT"
                            ]
                        }
                    }
                },
                {
                    "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-ContactRank",
            "valuePositiveInt": 1
        },
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator",
            "valueBoolean": true
        }
    ],
    "patient": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "relationship":  [
        {
            "coding":  [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                    "code": "WIFE",
                    "display": "wife"
                }
            ]
        }
    ],
    "name":  [
        {
            "use": "official",
            "family": "SMITH",
            "given":  [
                "Joy"
            ]
        }
    ]
}
back to top