HL7 FHIR® UK Core
4.0.0 - CI Build

HL7 FHIR® UK Core - Local Development build (v4.0.0). See the Directory of published versions

Extension: ExtensionUKCoreAddressKey

To support recording of Address Keys within addresses

The official URL for this extension is:

https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-AddressKey

Status: draft
Extension maintained by: Project Wildfyre

Context of Use

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

  • {"type"=>"Address"}

Usage info

Usage:

  • This Extension is not used in this Implementation Guide

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

Mandatory: 3 elements
Fixed Value: 3 elements
Prohibited: 1 element

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionAddress Key
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... extension:type 1..1ExtensionAddress Key Type
.... url 1..1uri"type"
.... value[x] 1..1CodingAddress Key Type
Binding: UK Core Address Key Type (extensible)
... extension:value 1..1Extension
.... url 1..1uri"value"
.... value[x] 0..1string
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..*ExtensionAddress Key
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:type I1..1ExtensionAddress Key Type
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uriidentifies the meaning of the extension
..... value[x] I0..1Value of extension
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
.... url 1..1uri"type"
.... value[x] I1..1CodingAddress Key Type
Binding: UK Core Address Key Type (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uriidentifies the meaning of the extension
..... value[x] I0..1Value of extension
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
.... url 1..1uri"value"
.... value[x] I0..1stringValue of extension
... url 1..1uri"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-AddressKey"

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 3 elements
Fixed Value: 3 elements
Prohibited: 1 element

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionAddress Key
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... extension:type 1..1ExtensionAddress Key Type
.... url 1..1uri"type"
.... value[x] 1..1CodingAddress Key Type
Binding: UK Core Address Key Type (extensible)
... extension:value 1..1Extension
.... url 1..1uri"value"
.... value[x] 0..1string
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..*ExtensionAddress Key
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:type I1..1ExtensionAddress Key Type
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uriidentifies the meaning of the extension
..... value[x] I0..1Value of extension
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
.... url 1..1uri"type"
.... value[x] I1..1CodingAddress Key Type
Binding: UK Core Address Key Type (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uriidentifies the meaning of the extension
..... value[x] I0..1Value of extension
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
.... url 1..1uri"value"
.... value[x] I0..1stringValue of extension
... url 1..1uri"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-AddressKey"

doco Documentation for this format

 

Other representations of extension: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
Extension.extension:type.value[x]extensibleUKCoreAddressKeyType

Constraints

Constraints

IdPathDetailsRequirements
ele-1ExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Extension.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Extension.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Extension.extension:typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Extension.extension:typeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Extension.extension:type.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Extension.extension:type.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Extension.extension:type.extension.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Extension.extension:type.extension.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Extension.extension:type.extension.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Extension.extension:type.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Extension.extension:valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Extension.extension:valueMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Extension.extension:value.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Extension.extension:value.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Extension.extension:value.extension.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Extension.extension:value.extension.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Extension.extension:value.extension.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Extension.extension:value.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())