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

Address

Important

This CodeSystem has may be new or has been amended since the last ballot. Users are advised to review all content carefully. Details of the changes can be found within the UK Core Version History.

Canonical_URL	Status	Current_Version	Last_Updated	Description	Profile_Purpose
https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey	active	3.0.0	2023-12-12	This carries an address identifier which will be included in an address.	This extension extends the Address datatype to support the exchange of the type of address identifier and the address identifier value.

Tree View

ExtensionUKCoreAddressKey (Extension)	C		Extension	Element id Extension Short description An extension carrying the address key and type Definition An extension carrying the address key and type. 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	2..*	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
type	C	1..1	Extension	Element id Extension.extension:type Short description Address Key Type Alternate names extensions, user content Definition To identify the type of Address Key recorded. 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:type.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:type.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:type.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 type Mappings rim: N/A
value[x]		1..1	Binding	Element id Extension.extension:type.value[x] Short description Address Key Type Definition To identify the type of Address Key recorded. Binding To identify the type of Address Key recorded UKCoreAddressKeyType (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
value	C	1..1	Extension	Element id Extension.extension:value Short description Address key value Alternate names extensions, user content Definition To record the value for the address key. 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:value.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:value.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:value.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 value Mappings rim: N/A
value[x]		1..1		Element id Extension.extension:value.value[x] Short description Address key value Definition To record the value for the address key. 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
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-AddressKey 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	An extension carrying the address key and type
Definition	An extension carrying the address key and type.
Cardinality	0..*
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	2..*
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:type
Short	Address Key Type
Definition	To identify the type of Address Key recorded.
Cardinality	1..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:type.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:type.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:type.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	type
Mappings	rim: N/A
Extension.extension:type.value[x]
Short	Address Key Type
Definition	To identify the type of Address Key recorded.
Cardinality	1..1
Type	CodeableConcept
Binding	To identify the type of Address Key recorded UKCoreAddressKeyType (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:value
Short	Address key value
Definition	To record the value for the address key.
Cardinality	1..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:value.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:value.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:value.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	value
Mappings	rim: N/A
Extension.extension:value.value[x]
Short	Address key value
Definition	To record the value for the address key.
Cardinality	1..1
Type	string
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-AddressKey
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		..
Extension.extension		2..
Extension.extension:type		1..1
Extension.extension:type.url		..
Extension.extension:type.value[x]	CodeableConcept	1..
Extension.extension:value		1..1
Extension.extension:value.url		..
Extension.extension:value.value[x]	string	1..
Extension.url		..
Extension.value[x]		..0

XML View

<id value="Extension-UKCore-AddressKey" />
<url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey" />
<version value="3.0.0" />
<name value="ExtensionUKCoreAddressKey" />
<title value="Extension UK Core Address Key" />
<status value="active" />
<date value="2023-12-12" />
<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="This carries an address identifier which will be included in an address." />
<purpose value="This extension extends the Address datatype to support the exchange of the type of address identifier and the address identifier value." />
<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="Address" />
</context>
<type value="Extension" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
<derivation value="constraint" />
<differential>
<element id="Extension">
<path value="Extension" />
<short value="An extension carrying the address key and type" />
<definition value="An extension carrying the address key and type." />
</element>
<element id="Extension.extension">
<path value="Extension.extension" />
<min value="2" />
</element>
<element id="Extension.extension:type">
<path value="Extension.extension" />
<sliceName value="type" />
<short value="Address Key Type" />
<definition value="To identify the type of Address Key recorded." />
<min value="1" />
<max value="1" />
</element>
<element id="Extension.extension:type.url">
<path value="Extension.extension.url" />
<fixedUri value="type" />
</element>
<element id="Extension.extension:type.value[x]">
<path value="Extension.extension.value[x]" />
<short value="Address Key Type" />
<definition value="To identify the type of Address Key recorded." />
<min value="1" />
<type>
<code value="CodeableConcept" />
</type>
<binding>
<strength value="extensible" />
<description value="To identify the type of Address Key recorded" />
<valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-AddressKeyType" />
</binding>
</element>
<element id="Extension.extension:value">
<path value="Extension.extension" />
<sliceName value="value" />
<short value="Address key value" />
<definition value="To record the value for the address key." />
<min value="1" />
<max value="1" />
</element>
<element id="Extension.extension:value.url">
<path value="Extension.extension.url" />
<fixedUri value="value" />
</element>
<element id="Extension.extension:value.value[x]">
<path value="Extension.extension.value[x]" />
<short value="Address key value" />
<definition value="To record the value for the address key." />
<min value="1" />
<type>
<code value="string" />
</type>
</element>
<element id="Extension.url">
<path value="Extension.url" />
<fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey" />
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]" />
<max value="0" />
</element>
</differential>

</StructureDefinition>

JSON View

{

"resourceType": "StructureDefinition",
"id": "Extension-UKCore-AddressKey",
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey",
"version": "3.0.0",
"name": "ExtensionUKCoreAddressKey",
"title": "Extension UK Core Address Key",
"status": "active",
"date": "2023-12-12",
"publisher": "HL7 UK",
"contact": [
{
"name": "HL7 UK",
"telecom": [
{
"system": "email",
"value": "ukcore@hl7.org.uk",
"use": "work",
"rank": 1
}
]
}
],
"description": "This carries an address identifier which will be included in an address.",
"purpose": "This extension extends the Address datatype to support the exchange of the type of address identifier and the address identifier value.",
"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": "Address"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "An extension carrying the address key and type",
"definition": "An extension carrying the address key and type."
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"min": 2
},
{
"id": "Extension.extension:type",
"path": "Extension.extension",
"sliceName": "type",
"short": "Address Key Type",
"definition": "To identify the type of Address Key recorded.",
"min": 1,
"max": "1"
},
{
"id": "Extension.extension:type.url",
"path": "Extension.extension.url",
"fixedUri": "type"
},
{
"id": "Extension.extension:type.value[x]",
"path": "Extension.extension.value[x]",
"short": "Address Key Type",
"definition": "To identify the type of Address Key recorded.",
"min": 1,
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "extensible",
"description": "To identify the type of Address Key recorded",
"valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-AddressKeyType"
}
},
{
"id": "Extension.extension:value",
"path": "Extension.extension",
"sliceName": "value",
"short": "Address key value",
"definition": "To record the value for the address key.",
"min": 1,
"max": "1"
},
{
"id": "Extension.extension:value.url",
"path": "Extension.extension.url",
"fixedUri": "value"
},
{
"id": "Extension.extension:value.value[x]",
"path": "Extension.extension.value[x]",
"short": "Address key value",
"definition": "To record the value for the address key.",
"min": 1,
"type": [
{
"code": "string"
}
]
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"max": "0"
}
]
}

}

Examples

id	div
Extension-UKCore-AddressKey-Example	An example to illustrate the use of an address key used with the address datatype

Feedback

Click here to:

Examples

Address Key- An example to illustrate how the address key information is carried in a patient example.
Extension-UKCore-AddressKey-Example

Extension Specific Guidance

There is a binding within this extension to a ValueSet-UKCore-AddressKeyType.

Breaking Change

The datatype of the type element was changed from valueCoding in UK Core STU1 Sequence, to valueCodeableConcept, as a result of the UK Core STU2 Sequence ballot reconciliation actions.