Interweave Implementation Guide
0.1.0 - ci-build United Kingdom flag

Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.

Extension: Extension UK Core Address Key

Official URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey Version: 3.0.0
Active as of 2023-12-12 Computable Name: ExtensionUKCoreAddressKey

Copyright/Legal: 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.

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.

Context of Use

This extension may be used on the following element(s):

  • Element ID Address

Usage info

Usage:

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

Summary

Complex Extension: This carries an address identifier which will be included in an address.

  • type: CodeableConcept: To identify the type of Address Key recorded.
  • value: string: To record the value for the address key.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension An extension carrying the address key and type
... extension 2..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:type 1..1 Extension Address Key Type
..... extension 0..0
..... url 1..1 uri "type"
..... value[x] 1..1 CodeableConcept Address Key Type
Binding: UK Core Address Key Type (extensible): To identify the type of Address Key recorded

... Slices for extension Content/Rules for all slices
.... extension:value 1..1 Extension Address key value
..... extension 0..0
..... url 1..1 uri "value"
..... value[x] 1..1 string Address key value
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension An extension carrying the address key and type
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:type 1..1 Extension Address Key Type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "type"
..... value[x] 1..1 CodeableConcept Address Key Type
Binding: UK Core Address Key Type (extensible): To identify the type of Address Key recorded

.... extension:value 1..1 Extension Address key value
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "value"
..... value[x] 1..1 string Address key value
... url 1..1 uri "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This carries an address identifier which will be included in an address.

  • type: CodeableConcept: To identify the type of Address Key recorded.
  • value: string: To record the value for the address key.

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension An extension carrying the address key and type
... extension 2..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:type 1..1 Extension Address Key Type
..... extension 0..0
..... url 1..1 uri "type"
..... value[x] 1..1 CodeableConcept Address Key Type
Binding: UK Core Address Key Type (extensible): To identify the type of Address Key recorded

... Slices for extension Content/Rules for all slices
.... extension:value 1..1 Extension Address key value
..... extension 0..0
..... url 1..1 uri "value"
..... value[x] 1..1 string Address key value
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension An extension carrying the address key and type
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:type 1..1 Extension Address Key Type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "type"
..... value[x] 1..1 CodeableConcept Address Key Type
Binding: UK Core Address Key Type (extensible): To identify the type of Address Key recorded

.... extension:value 1..1 Extension Address key value
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "value"
..... value[x] 1..1 string Address key value
... url 1..1 uri "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:type.value[x]extensibleUKCoreAddressKeyType (a valid code from https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType)
https://fhir.hl7.org.uk/ValueSet/UKCore-AddressKeyType
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()