UK Core Implementation Guide STU3 Sequence

Please note:

This version of the UK Core is a development copy.
This contains BREAKING CHANGES as a result of the C&TA Sprint 7 Review, and STU2 Sequence ballot reconciliation.
This version is not yet reviewed for implementation. Other versions are available on the UK Core Version History Guide
Please follow the guidance on the Contact Us page if you need any assistance.
A summary of changes is available on the STU3 Sequence Change Log

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

Table View

Encounter.id[0]	UKCore-Extension-LegalStatus-Example
Encounter.text[0].status[0]	additional
Encounter.text[0].div[0]	<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the extension which is used to indicate a patient's legal status on admission or discharge</div>
Encounter.extension[0].extension[0].url[0]	legalStatusContext
Encounter.extension[0].extension[0].value[0].coding[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-LegalStatusContext
Encounter.extension[0].extension[0].value[0].coding[0].code[0]	admission
Encounter.extension[0].extension[0].value[0].coding[0].display[0]	Admission
Encounter.extension[0].extension[1].url[0]	legalStatusClassification
Encounter.extension[0].extension[1].value[0].coding[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-LegalStatusClassificationWales
Encounter.extension[0].extension[1].value[0].coding[0].code[0]	02
Encounter.extension[0].extension[1].value[0].coding[0].display[0]	Formally detained under Mental Health Act Section 2 (Admission for assessment)
Encounter.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus
Encounter.status[0]	finished
Encounter.class[0].system[0]	http://terminology.hl7.org/CodeSystem/v3-ActCode
Encounter.class[0].code[0]	IMP
Encounter.class[0].display[0]	inpatient encounter

Tree View

Encounter

id : UKCore-Extension-LegalStatus-Example

text

status : additional

extension

url : https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus

extension

url : legalStatusContext

value

coding

system : https://fhir.hl7.org.uk/CodeSystem/UKCore-LegalStatusContext

code : admission

display : Admission

extension

url : legalStatusClassification

value

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

XML View

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

JSON View

{
    "resourceType": "Encounter",
    "id": "UKCore-Extension-LegalStatus-Example",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "extension":  [
        {
            "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"
    }
}