This carries an address key which will be included in an address.
This extension extends the Address datatype to support the exchange of the type of address key and the address key value, which are currently not supported by the FHIR standard.
Context of Use | |
---|---|
Use on element | Address |
Extension | .. | |
Extension.extension | .. | |
Extension.extension | 1..1 | |
Extension.extension.url | .. | |
Extension.extension.value[x] | Coding | 1.. |
Extension.extension | 1..1 | |
Extension.extension.url | .. | |
Extension.extension.value[x] | string | 1.. |
Extension.url | .. | |
Extension.value[x] | ..0 |
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-AddressKey" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey" /> <version value="2.1.0" /> <name value="ExtensionUKCoreAddressKey" /> <title value="Extension UK Core Address Key" /> <status value="active" /> <date value="2021-09-10" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </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, which are currently not supported by the FHIR standard." /> <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" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <rules value="open" /> </slicing> </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="Coding" /> </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>
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-AddressKey", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey", "version": "2.1.0", "name": "ExtensionUKCoreAddressKey", "title": "Extension UK Core Address Key", "status": "active", "date": "2021-09-10", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "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, which are currently not supported by the FHIR standard.", "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", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" } }, { "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": "Coding" } ], "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" } ] } }