UK Core Implementation Guide STU2 Sequence

Please note:

Items highlighted in green have been Added, or Updated, and are undergoing review in this STU2 ballot.
A summary of changes is available here: Version History

Important note regarding changes to STU1 profiles:

The bindings for all SNOMED CT ValueSets have been changed to "preferred".
A proposed minimum viable content table has been added to each resource.

These changes are not currently approved and are submitted for comment as part of this STU2 ballot.

StructureDefinition Extension-UKCore-ContactPreference

Canonical_URL	Description	Profile_Purpose
https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference	The preferred method of contact, contact times and written communication format given by a Patient or Related Person.	This extension extends the Patient and RelatedPerson resources to support the exchange of their preferred method of contact, contact times and written communication format.

Context of Use

RelatedPerson
Patient

Tree View

Extension	I		Extension	Element Id Extension Short description The preferred method of contact, contact times and written communication format given by a Patient or Related Person. Definition The preferred method of contact, contact times and written communication format given by a Patient or Related Person. Data Type Extension Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
extension	I	0..*	Extension	Element Id Extension.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
PreferredContactMethod	I	0..1	Extension	Element Id Extension.extension:PreferredContactMethod Short description Preferred Contact Method Alternate names extensions, user content Definition The preferred method of contact given by a Patient or Related Person. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
url		1..1	System.StringFixed Value	Element Id Extension.extension:PreferredContactMethod.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value PreferredContactMethod Mappings rim:N/A
value[x]		1..1	Binding	Element Id Extension.extension:PreferredContactMethod.value[x] Short description Preferred Contact Method Definition The preferred method of contact given by a Patient or Related Person. Binding UKCorePreferredContactMethod (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueCodeableConcept			CodeableConcept	Data Type CodeableConcept
PreferredContactTimes	I	0..1	Extension	Element Id Extension.extension:PreferredContactTimes Short description Preferred Contact Times Alternate names extensions, user content Definition The preferred contact times given by a Patient or Related Person. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
url		1..1	System.StringFixed Value	Element Id Extension.extension:PreferredContactTimes.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value PreferredContactTimes Mappings rim:N/A
value[x]		1..1		Element Id Extension.extension:PreferredContactTimes.value[x] Short description Preferred Contact Times Definition The preferred contact time period given by a Patient or Related Person. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueString			string	Data Type string
valueTiming			Timing	Data Type Timing
PreferredWrittenCommunicationFormat	I	0..1	Extension	Element Id Extension.extension:PreferredWrittenCommunicationFormat Short description Preferred Written Communication Format Alternate names extensions, user content Definition The preferred written communication format given by a Patient or Related Person. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
url		1..1	System.StringFixed Value	Element Id Extension.extension:PreferredWrittenCommunicationFormat.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value PreferredWrittenCommunicationFormat Mappings rim:N/A
value[x]		1..1	Binding	Element Id Extension.extension:PreferredWrittenCommunicationFormat.value[x] Short description Preferred Written Communication Format Definition The preferred written communication format given by a Patient or Related Person. Binding UKCorePreferredWrittenCommunicationFormat (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueCodeableConcept			CodeableConcept	Data Type CodeableConcept
url		1..1	System.StringFixed Value	Element Id Extension.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference Mappings rim:N/A
value[x]		0..0		There are no (further) constraints on this element Element Id Extension.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A

Table View

Extension		..1
Extension.extension		0..
Extension.extension		0..1
Extension.extension.url		..
Extension.extension.value[x]	CodeableConcept	1..
Extension.extension		0..1
Extension.extension.url		..
Extension.extension.value[x]	string, Timing	1..
Extension.extension		0..1
Extension.extension.url		..
Extension.extension.value[x]	CodeableConcept	1..
Extension.url		..
Extension.value[x]		..0

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Extension-UKCore-ContactPreference" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference" />
    <version value="2.2.0" />
    <name value="ExtensionUKCoreContactPreference" />
    <title value="Extension UK Core Contact Preference" />
    <status value="active" />
    <date value="2022-01-07" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="The preferred method of contact, contact times and written communication format given by a Patient or Related Person." />
    <purpose value="This extension extends the Patient and RelatedPerson resources to support the exchange of their preferred method of contact, contact times and written communication format." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <kind value="complex-type" />
    <abstract value="false" />
    <context>
        <type value="element" />
        <expression value="Patient" />
    </context>
    <context>
        <type value="element" />
        <expression value="RelatedPerson" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <short value="The preferred method of contact, contact times and written communication format given by a Patient or Related Person." />
            <definition value="The preferred method of contact, contact times and written communication format given by a Patient or Related Person." />
            <max value="1" />
        </element>
        <element id="Extension.extension">
            <path value="Extension.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="0" />
        </element>
        <element id="Extension.extension:PreferredContactMethod">
            <path value="Extension.extension" />
            <sliceName value="PreferredContactMethod" />
            <short value="Preferred Contact Method" />
            <definition value="The preferred method of contact given by a Patient or Related Person." />
            <min value="0" />
            <max value="1" />
        </element>
        <element id="Extension.extension:PreferredContactMethod.url">
            <path value="Extension.extension.url" />
            <fixedUri value="PreferredContactMethod" />
        </element>
        <element id="Extension.extension:PreferredContactMethod.value[x]">
            <path value="Extension.extension.value[x]" />
            <short value="Preferred Contact Method" />
            <definition value="The preferred method of contact given by a Patient or Related Person." />
            <min value="1" />
            <type>
                <code value="CodeableConcept" />
            </type>
            <binding>
                <strength value="extensible" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PreferredContactMethod" />
            </binding>
        </element>
        <element id="Extension.extension:PreferredContactTimes">
            <path value="Extension.extension" />
            <sliceName value="PreferredContactTimes" />
            <short value="Preferred Contact Times" />
            <definition value="The preferred contact times given by a Patient or Related Person." />
            <min value="0" />
            <max value="1" />
        </element>
        <element id="Extension.extension:PreferredContactTimes.url">
            <path value="Extension.extension.url" />
            <fixedUri value="PreferredContactTimes" />
        </element>
        <element id="Extension.extension:PreferredContactTimes.value[x]">
            <path value="Extension.extension.value[x]" />
            <short value="Preferred Contact Times" />
            <definition value="The preferred contact time period given by a Patient or Related Person." />
            <min value="1" />
            <type>
                <code value="string" />
            </type>
            <type>
                <code value="Timing" />
            </type>
        </element>
        <element id="Extension.extension:PreferredWrittenCommunicationFormat">
            <path value="Extension.extension" />
            <sliceName value="PreferredWrittenCommunicationFormat" />
            <short value="Preferred Written Communication Format" />
            <definition value="The preferred written communication format given by a Patient or Related Person." />
            <min value="0" />
            <max value="1" />
        </element>
        <element id="Extension.extension:PreferredWrittenCommunicationFormat.url">
            <path value="Extension.extension.url" />
            <fixedUri value="PreferredWrittenCommunicationFormat" />
        </element>
        <element id="Extension.extension:PreferredWrittenCommunicationFormat.value[x]">
            <path value="Extension.extension.value[x]" />
            <short value="Preferred Written Communication Format" />
            <definition value="The preferred written communication format given by a Patient or Related Person." />
            <min value="1" />
            <type>
                <code value="CodeableConcept" />
            </type>
            <binding>
                <strength value="extensible" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PreferredWrittenCommunicationFormat" />
            </binding>
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <max value="0" />
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-UKCore-ContactPreference",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference",
    "version": "2.2.0",
    "name": "ExtensionUKCoreContactPreference",
    "title": "Extension UK Core Contact Preference",
    "status": "active",
    "date": "2022-01-07",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "The preferred method of contact, contact times and written communication format given by a Patient or Related Person.",
    "purpose": "This extension extends the Patient and RelatedPerson resources to support the exchange of their preferred method of contact, contact times and written communication format.",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        }
    ],
    "kind": "complex-type",
    "abstract": false,
    "context":  [
        {
            "type": "element",
            "expression": "Patient"
        },
        {
            "type": "element",
            "expression": "RelatedPerson"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "The preferred method of contact, contact times and written communication format given by a Patient or Related Person.",
                "definition": "The preferred method of contact, contact times and written communication format given by a Patient or Related Person.",
                "max": "1"
            },
            {
                "id": "Extension.extension",
                "path": "Extension.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "Extension.extension:PreferredContactMethod",
                "path": "Extension.extension",
                "sliceName": "PreferredContactMethod",
                "short": "Preferred Contact Method",
                "definition": "The preferred method of contact given by a Patient or Related Person.",
                "min": 0,
                "max": "1"
            },
            {
                "id": "Extension.extension:PreferredContactMethod.url",
                "path": "Extension.extension.url",
                "fixedUri": "PreferredContactMethod"
            },
            {
                "id": "Extension.extension:PreferredContactMethod.value[x]",
                "path": "Extension.extension.value[x]",
                "short": "Preferred Contact Method",
                "definition": "The preferred method of contact given by a Patient or Related Person.",
                "min": 1,
                "type":  [
                    {
                        "code": "CodeableConcept"
                    }
                ],
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PreferredContactMethod"
                }
            },
            {
                "id": "Extension.extension:PreferredContactTimes",
                "path": "Extension.extension",
                "sliceName": "PreferredContactTimes",
                "short": "Preferred Contact Times",
                "definition": "The preferred contact times given by a Patient or Related Person.",
                "min": 0,
                "max": "1"
            },
            {
                "id": "Extension.extension:PreferredContactTimes.url",
                "path": "Extension.extension.url",
                "fixedUri": "PreferredContactTimes"
            },
            {
                "id": "Extension.extension:PreferredContactTimes.value[x]",
                "path": "Extension.extension.value[x]",
                "short": "Preferred Contact Times",
                "definition": "The preferred contact time period given by a Patient or Related Person.",
                "min": 1,
                "type":  [
                    {
                        "code": "string"
                    },
                    {
                        "code": "Timing"
                    }
                ]
            },
            {
                "id": "Extension.extension:PreferredWrittenCommunicationFormat",
                "path": "Extension.extension",
                "sliceName": "PreferredWrittenCommunicationFormat",
                "short": "Preferred Written Communication Format",
                "definition": "The preferred written communication format given by a Patient or Related Person.",
                "min": 0,
                "max": "1"
            },
            {
                "id": "Extension.extension:PreferredWrittenCommunicationFormat.url",
                "path": "Extension.extension.url",
                "fixedUri": "PreferredWrittenCommunicationFormat"
            },
            {
                "id": "Extension.extension:PreferredWrittenCommunicationFormat.value[x]",
                "path": "Extension.extension.value[x]",
                "short": "Preferred Written Communication Format",
                "definition": "The preferred written communication format given by a Patient or Related Person.",
                "min": 1,
                "type":  [
                    {
                        "code": "CodeableConcept"
                    }
                ],
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PreferredWrittenCommunicationFormat"
                }
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "max": "0"
            }
        ]
    }
}

Examples

Contact Preference- An example to illustrate the extension for a patient's contact preferences.
Example UKCore-Patient-Extension-ContactPreference

Guidance

There are two bindings within this extension. PreferredContactMethod element to ValueSet UKCore-PreferredContactMethod , and PreferredWrittenCommunicationFormat element to ValueSet UKCore-PreferredWrittenCommunicationFormat.