HL7 Europe Base and Core FHIR IG
0.1.0-ballotRecon - ci-build 150

HL7 Europe Base and Core FHIR IG, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.1.0-ballotRecon built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/base/ and changes regularly. See the Directory of published versions

Data Type Profile: Address (EU)

Official URL: http://hl7.eu/fhir/base/StructureDefinition/Address-eu Version: 0.1.0-ballotRecon
Standards status: Draft Maturity Level: 2 Computable Name: AddressEu

Copyright/Legal: Copyright HL7 Europe. Licensed under creative commons public domain (CC0 1.0).

This profile extends the Address data type for supporting streetname, housenumber and postal box.

Address extensions

The Address extensions provide additional information about a patient's address, as the fact that it is an official address, or more structured information about the address itself.

This profile doesn't explicitly list all of them, but only those that are explicitly listed in the EHDS Address model.

Examples of extensions not included, but used in several jurisdictions are:

Implementers should refer to the HL7 FHIR specification for guidance on the use of these extensions.

Please note that the fact they are not included in the differential doesn't preclude their use in a compliant instance.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Address 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... use ?!Σ 0..1 code Purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
... type Σ 0..1 code Address type (postal | physical)
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:streetName 0..* string streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... extension:houseNumber 0..* string houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... extension:postBox 0..* string postBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
... postalCode Σ 0..1 string Postal code
Example General: 9132

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
From the FHIR Standard
Address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
From the FHIR Standard

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()

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Address 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... use 0..1 code Purpose of this address
... type 0..1 code Address type (postal | physical)
... line 0..* string Street name, number, direction & P.O. Box etc.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:streetName 0..* string streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... extension:houseNumber 0..* string houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... extension:postBox 0..* string postBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
... postalCode 0..1 string Postal code
... country
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:countryCode 0..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
...... value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Address.country.extension:countryCode.value[x]preferredIso3166-1-2
http://hl7.org/fhir/ValueSet/iso3166-1-2
From the FHIR Standard
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Address 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ 0..1 code Purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:streetName 0..* string streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... extension:houseNumber 0..* string houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... extension:postBox 0..* string postBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
.... value 0..1 string Primitive value for string
Max Length:1048576
... city Σ 0..1 string City
Example General: Erewhon
... district Σ 0..1 string District name (aka county)
Example General: Madison
... state Σ 0..1 string Sub-unit of country (abbreviations ok)
... postalCode Σ 0..1 string Postal code
Example General: 9132
... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:countryCode 0..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
...... value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (preferred)
.... value 0..1 string Primitive value for string
Max Length:1048576
... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
From the FHIR Standard
Address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
From the FHIR Standard
Address.country.extension:countryCode.value[x]preferredIso3166-1-2
http://hl7.org/fhir/ValueSet/iso3166-1-2
From the FHIR Standard

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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Address 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... use ?!Σ 0..1 code Purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
... type Σ 0..1 code Address type (postal | physical)
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:streetName 0..* string streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... extension:houseNumber 0..* string houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... extension:postBox 0..* string postBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
... postalCode Σ 0..1 string Postal code
Example General: 9132

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
From the FHIR Standard
Address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
From the FHIR Standard

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()

Differential View

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Address 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... use 0..1 code Purpose of this address
... type 0..1 code Address type (postal | physical)
... line 0..* string Street name, number, direction & P.O. Box etc.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:streetName 0..* string streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... extension:houseNumber 0..* string houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... extension:postBox 0..* string postBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
... postalCode 0..1 string Postal code
... country
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:countryCode 0..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
...... value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Address.country.extension:countryCode.value[x]preferredIso3166-1-2
http://hl7.org/fhir/ValueSet/iso3166-1-2
From the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Address 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ 0..1 code Purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:streetName 0..* string streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... extension:houseNumber 0..* string houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... extension:postBox 0..* string postBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
.... value 0..1 string Primitive value for string
Max Length:1048576
... city Σ 0..1 string City
Example General: Erewhon
... district Σ 0..1 string District name (aka county)
Example General: Madison
... state Σ 0..1 string Sub-unit of country (abbreviations ok)
... postalCode Σ 0..1 string Postal code
Example General: 9132
... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:countryCode 0..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
...... value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (preferred)
.... value 0..1 string Primitive value for string
Max Length:1048576
... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
From the FHIR Standard
Address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
From the FHIR Standard
Address.country.extension:countryCode.value[x]preferredIso3166-1-2
http://hl7.org/fhir/ValueSet/iso3166-1-2
From the FHIR Standard

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()

 

Other representations of profile: CSV, Excel, Schematron