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 for a patient's contact preferences

Table View

Patient.id[0]	UKCore-Extension-ContactPreference-Example
Patient.text[0].status[0]	additional
Patient.text[0].div[0]	<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate the extension for a patient's contact preferences</div>
Patient.extension[0].extension[0].url[0]	PreferredContactMethod
Patient.extension[0].extension[0].value[0].coding[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod
Patient.extension[0].extension[0].value[0].coding[0].code[0]	3
Patient.extension[0].extension[0].value[0].coding[0].display[0]	Telephone
Patient.extension[0].extension[1].url[0]	PreferredContactTimes
Patient.extension[0].extension[1].value[0].repeat[0].frequency[0]	1
Patient.extension[0].extension[1].value[0].repeat[0].period[0]	1
Patient.extension[0].extension[1].value[0].repeat[0].periodUnit[0]	d
Patient.extension[0].extension[1].value[0].repeat[0].dayOfWeek[0]	mon
Patient.extension[0].extension[1].value[0].repeat[0].dayOfWeek[1]	wed
Patient.extension[0].extension[1].value[0].repeat[0].dayOfWeek[2]	fri
Patient.extension[0].extension[1].value[0].repeat[0].when[0]	MORN
Patient.extension[0].extension[2].url[0]	PreferredWrittenCommunicationFormat
Patient.extension[0].extension[2].value[0].coding[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat
Patient.extension[0].extension[2].value[0].coding[0].code[0]	11
Patient.extension[0].extension[2].value[0].coding[0].display[0]	Large print
Patient.extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference

Tree View

Patient

id : UKCore-Extension-ContactPreference-Example

text

status : additional

extension

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

extension

url : PreferredContactMethod

value

coding

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

code : 3

display : Telephone

extension

url : PreferredContactTimes

value

repeat

frequency : 1

period : 1

periodUnit : d

dayOfWeek : mon

dayOfWeek : wed

dayOfWeek : fri

when : MORN

extension

url : PreferredWrittenCommunicationFormat

value

coding

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

code : 11

display : Large print

XML View

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

JSON View

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