Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.
| Active as of 2023-12-12 |
XML representation of the Extension-UKCore-AddressKey extension.
<StructureDefinition xmlns="http://hl7.org/fhir">
<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="Interweave Publisher"/>
<contact>
<name value="Interweave Publisher"/>
<telecom>
<system value="url"/>
<value value="https://fhir.interweavedigital.com/yhcr-publisher"/>
</telecom>
</contact>
<description
value="This carries an address identifier which will be included in an address."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="GB"/>
<display value="United Kingdom of Great Britain and Northern Ireland"/>
</coding>
</jurisdiction>
<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"/>
<snapshot>
<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."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Extension"/>
<min value="0"/>
<max value="*"/>
</base>
<condition value="ele-1"/>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
</element>
<element id="Extension.id">
<path value="Extension.id"/>
<representation value="xmlAttr"/>
<short value="Unique id for inter-element referencing"/>
<definition
value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Element.id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Extension.extension">
<path value="Extension.extension"/>
<slicing>
<discriminator>
<type value="value"/>
<path value="url"/>
</discriminator>
<description value="Extensions are always sliced by (at least) url"/>
<rules value="open"/>
</slicing>
<short value="Extension"/>
<definition value="An Extension"/>
<min value="2"/>
<max value="*"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
</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"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="Extension.extension:type.id">
<path value="Extension.extension.id"/>
<representation value="xmlAttr"/>
<short value="Unique id for inter-element referencing"/>
<definition
value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Element.id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Extension.extension:type.extension">
<path value="Extension.extension.extension"/>
<slicing>
<discriminator>
<type value="value"/>
<path value="url"/>
</discriminator>
<description value="Extensions are always sliced by (at least) url"/>
<rules value="open"/>
</slicing>
<short value="Extension"/>
<definition value="An Extension"/>
<min value="0"/>
<max value="0"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="Extension.extension:type.url">
<path value="Extension.extension.url"/>
<representation value="xmlAttr"/>
<short value="identifies the meaning of the extension"/>
<definition
value="Source of the definition for the extension code - a logical name or a URL."/>
<comment
value="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."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Extension.url"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="uri"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<fixedUri value="type"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</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"/>
<max value="1"/>
<base>
<path value="Extension.value[x]"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="CodeableConcept"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<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>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</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"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="Extension.extension:value.id">
<path value="Extension.extension.id"/>
<representation value="xmlAttr"/>
<short value="Unique id for inter-element referencing"/>
<definition
value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Element.id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Extension.extension:value.extension">
<path value="Extension.extension.extension"/>
<slicing>
<discriminator>
<type value="value"/>
<path value="url"/>
</discriminator>
<description value="Extensions are always sliced by (at least) url"/>
<rules value="open"/>
</slicing>
<short value="Extension"/>
<definition value="An Extension"/>
<min value="0"/>
<max value="0"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="Extension.extension:value.url">
<path value="Extension.extension.url"/>
<representation value="xmlAttr"/>
<short value="identifies the meaning of the extension"/>
<definition
value="Source of the definition for the extension code - a logical name or a URL."/>
<comment
value="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."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Extension.url"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="uri"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<fixedUri value="value"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</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"/>
<max value="1"/>
<base>
<path value="Extension.value[x]"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="Extension.url">
<path value="Extension.url"/>
<representation value="xmlAttr"/>
<short value="identifies the meaning of the extension"/>
<definition
value="Source of the definition for the extension code - a logical name or a URL."/>
<comment
value="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."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Extension.url"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="uri"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<fixedUri
value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]"/>
<short value="Value of extension"/>
<definition
value="Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list)."/>
<min value="0"/>
<max value="0"/>
<base>
<path value="Extension.value[x]"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="base64Binary"/>
</type>
<type>
<code value="boolean"/>
</type>
<type>
<code value="canonical"/>
</type>
<type>
<code value="code"/>
</type>
<type>
<code value="date"/>
</type>
<type>
<code value="dateTime"/>
</type>
<type>
<code value="decimal"/>
</type>
<type>
<code value="id"/>
</type>
<type>
<code value="instant"/>
</type>
<type>
<code value="integer"/>
</type>
<type>
<code value="markdown"/>
</type>
<type>
<code value="oid"/>
</type>
<type>
<code value="positiveInt"/>
</type>
<type>
<code value="string"/>
</type>
<type>
<code value="time"/>
</type>
<type>
<code value="unsignedInt"/>
</type>
<type>
<code value="uri"/>
</type>
<type>
<code value="url"/>
</type>
<type>
<code value="uuid"/>
</type>
<type>
<code value="Address"/>
</type>
<type>
<code value="Age"/>
</type>
<type>
<code value="Annotation"/>
</type>
<type>
<code value="Attachment"/>
</type>
<type>
<code value="CodeableConcept"/>
</type>
<type>
<code value="Coding"/>
</type>
<type>
<code value="ContactPoint"/>
</type>
<type>
<code value="Count"/>
</type>
<type>
<code value="Distance"/>
</type>
<type>
<code value="Duration"/>
</type>
<type>
<code value="HumanName"/>
</type>
<type>
<code value="Identifier"/>
</type>
<type>
<code value="Money"/>
</type>
<type>
<code value="Period"/>
</type>
<type>
<code value="Quantity"/>
</type>
<type>
<code value="Range"/>
</type>
<type>
<code value="Ratio"/>
</type>
<type>
<code value="Reference"/>
</type>
<type>
<code value="SampledData"/>
</type>
<type>
<code value="Signature"/>
</type>
<type>
<code value="Timing"/>
</type>
<type>
<code value="ContactDetail"/>
</type>
<type>
<code value="Contributor"/>
</type>
<type>
<code value="DataRequirement"/>
</type>
<type>
<code value="Expression"/>
</type>
<type>
<code value="ParameterDefinition"/>
</type>
<type>
<code value="RelatedArtifact"/>
</type>
<type>
<code value="TriggerDefinition"/>
</type>
<type>
<code value="UsageContext"/>
</type>
<type>
<code value="Dosage"/>
</type>
<type>
<code value="Meta"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
</snapshot>
<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.extension">
<path value="Extension.extension.extension"/>
<max value="0"/>
</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.extension">
<path value="Extension.extension.extension"/>
<max value="0"/>
</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>