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

StructureDefinition

Context of Use

Canonical_URL	Status	Current_Version	Last_Updated	Description	Profile_Purpose
https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference	active	2.3.0	2023-12-07	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.

Tree View

ExtensionUKCoreContactPreference (Extension)	C		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 Conditions The cardinality or value of this element may be affected by these constraints: ele-1 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
id		0..1	string	There are no (further) constraints on this element Element id Extension.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element 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 Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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
PreferredContactMethod	C	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
id		0..1	string	There are no (further) constraints on this element Element id Extension.extension:PreferredContactMethod.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id Extension.extension:PreferredContactMethod.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 Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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
url		1..1	uriFixed 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 uri 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
valueCodeableConcept			CodeableConcept	Data type CodeableConcept
PreferredContactTimes	C	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
id		0..1	string	There are no (further) constraints on this element Element id Extension.extension:PreferredContactTimes.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id Extension.extension:PreferredContactTimes.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 Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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
url		1..1	uriFixed 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 uri 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
valueString			string	Data type string
valueTiming			Timing	Data type Timing
PreferredWrittenCommunicationFormat	C	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
id		0..1	string	There are no (further) constraints on this element Element id Extension.extension:PreferredWrittenCommunicationFormat.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id Extension.extension:PreferredWrittenCommunicationFormat.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 Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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
url		1..1	uriFixed 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 uri 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
valueCodeableConcept			CodeableConcept	Data type CodeableConcept
url		1..1	uriFixed 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 uri 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

Detailed Descriptions

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.
Cardinality	0..1
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
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.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Mappings	rim: n/a
Extension.extension
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
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.
Slicing	Unordered, Open, by url(Value) Extensions are always sliced by (at least) url
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
Extension.extension:PreferredContactMethod
Short	Preferred Contact Method
Definition	The preferred method of contact given by a Patient or Related Person.
Cardinality	0..1
Type	Extension
Alias	extensions, user content
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.
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
Extension.extension:PreferredContactMethod.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Mappings	rim: n/a
Extension.extension:PreferredContactMethod.extension
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
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.
Slicing	Unordered, Open, by url(Value) Extensions are always sliced by (at least) url
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
Extension.extension:PreferredContactMethod.url
Short	identifies the meaning of the extension
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1..1
Type	uri
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.
Fixed Value	PreferredContactMethod
Mappings	rim: N/A
Extension.extension:PreferredContactMethod.value[x]
Short	Preferred Contact Method
Definition	The preferred method of contact given by a Patient or Related Person.
Cardinality	1..1
Type	CodeableConcept
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
Extension.extension:PreferredContactTimes
Short	Preferred Contact Times
Definition	The preferred contact times given by a Patient or Related Person.
Cardinality	0..1
Type	Extension
Alias	extensions, user content
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.
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
Extension.extension:PreferredContactTimes.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Mappings	rim: n/a
Extension.extension:PreferredContactTimes.extension
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
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.
Slicing	Unordered, Open, by url(Value) Extensions are always sliced by (at least) url
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
Extension.extension:PreferredContactTimes.url
Short	identifies the meaning of the extension
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1..1
Type	uri
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.
Fixed Value	PreferredContactTimes
Mappings	rim: N/A
Extension.extension:PreferredContactTimes.value[x]
Short	Preferred Contact Times
Definition	The preferred contact time period given by a Patient or Related Person.
Cardinality	1..1
Type	string, Timing
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A
Extension.extension:PreferredWrittenCommunicationFormat
Short	Preferred Written Communication Format
Definition	The preferred written communication format given by a Patient or Related Person.
Cardinality	0..1
Type	Extension
Alias	extensions, user content
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.
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
Extension.extension:PreferredWrittenCommunicationFormat.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Mappings	rim: n/a
Extension.extension:PreferredWrittenCommunicationFormat.extension
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
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.
Slicing	Unordered, Open, by url(Value) Extensions are always sliced by (at least) url
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
Extension.extension:PreferredWrittenCommunicationFormat.url
Short	identifies the meaning of the extension
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1..1
Type	uri
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.
Fixed Value	PreferredWrittenCommunicationFormat
Mappings	rim: N/A
Extension.extension:PreferredWrittenCommunicationFormat.value[x]
Short	Preferred Written Communication Format
Definition	The preferred written communication format given by a Patient or Related Person.
Cardinality	1..1
Type	CodeableConcept
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
Extension.url
Short	identifies the meaning of the extension
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1..1
Type	uri
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.
Fixed Value	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference
Mappings	rim: N/A
Extension.value[x]
Short	Value of extension
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Cardinality	0..0
Type	base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A

Table View

Extension		..1
Extension.extension:PreferredContactMethod		..1
Extension.extension:PreferredContactMethod.url		..
Extension.extension:PreferredContactMethod.value[x]	CodeableConcept	1..
Extension.extension:PreferredContactTimes		..1
Extension.extension:PreferredContactTimes.url		..
Extension.extension:PreferredContactTimes.value[x]	string, Timing	1..
Extension.extension:PreferredWrittenCommunicationFormat		..1
Extension.extension:PreferredWrittenCommunicationFormat.url		..
Extension.extension:PreferredWrittenCommunicationFormat.value[x]	CodeableConcept	1..
Extension.url		..
Extension.value[x]		..0

XML View

<id value="Extension-UKCore-ContactPreference" />
<url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference" />
<version value="2.3.0" />
<name value="ExtensionUKCoreContactPreference" />
<title value="Extension UK Core Contact Preference" />
<status value="active" />
<date value="2023-12-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 © 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 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: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." />
<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." />
<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." />
<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.3.0",
"name": "ExtensionUKCoreContactPreference",
"title": "Extension UK Core Contact Preference",
"status": "active",
"date": "2023-12-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:PreferredContactMethod",
"path": "Extension.extension",
"sliceName": "PreferredContactMethod",
"short": "Preferred Contact Method",
"definition": "The preferred method of contact given by a Patient or Related Person.",
"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.",
"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.",
"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

Feedback

Click here to:

Examples

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

Extension Specific Guidance

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