Belgium eHealth FHIR Core specifications
1.2.2 - CI Build

This page is part of the Belgium eHealth FHIR Core specifications (v1.2.2: Trial Use) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Data Type Profile:

Defining URL:https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-address
Version:1.2.2
Name:BeAddress
Status:Active as of 2021-07-10T14:45:27+02:00
Definition:

Belgain federal profile on address, to provide the possibility in the 'line' element to provide a seperate streetname, housenumber and postal box. It is always RECOMMENDED to give these elements seperately.

Publisher:eHealth
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-address

Formal Views of Profile Content

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

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... language 0..*codeHuman Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... line 0..*stringStreet name, number, direction & P.O. Box etc.
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... iso21090-ADXP-streetName 0..*stringstreetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... value[x] 1..1stringValue of extension
.... iso21090-ADXP-houseNumber 0..*stringhouseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... value[x] 1..1stringValue of extension
.... iso21090-ADXP-postBox 0..*stringpostBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
..... value[x] 1..1stringValue of extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... language 0..*codeHuman Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.


... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line Σ0..*stringStreet 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..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... iso21090-ADXP-streetName 0..*stringstreetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
..... value[x] 1..1stringValue of extension
.... iso21090-ADXP-houseNumber 0..*stringhouseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
..... value[x] 1..1stringValue of extension
.... iso21090-ADXP-postBox 0..*stringpostBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox"
..... value[x] 1..1stringValue of extension
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... city Σ0..1stringName of city, town etc.
Example General: Erewhon
... district Σ0..1stringDistrict name (aka county)
Example General: Madison
... state Σ0..1stringSub-unit of country (abbreviations ok)
... postalCode Σ0..1stringPostal code for area
Example General: 9132
... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)

doco Documentation for this format

Differential View

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... language 0..*codeHuman Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... line 0..*stringStreet name, number, direction & P.O. Box etc.
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... iso21090-ADXP-streetName 0..*stringstreetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... value[x] 1..1stringValue of extension
.... iso21090-ADXP-houseNumber 0..*stringhouseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... value[x] 1..1stringValue of extension
.... iso21090-ADXP-postBox 0..*stringpostBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
..... value[x] 1..1stringValue of extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... language 0..*codeHuman Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.


... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line Σ0..*stringStreet 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..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... iso21090-ADXP-streetName 0..*stringstreetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
..... value[x] 1..1stringValue of extension
.... iso21090-ADXP-houseNumber 0..*stringhouseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
..... value[x] 1..1stringValue of extension
.... iso21090-ADXP-postBox 0..*stringpostBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox"
..... value[x] 1..1stringValue of extension
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... city Σ0..1stringName of city, town etc.
Example General: Erewhon
... district Σ0..1stringDistrict name (aka county)
Example General: Madison
... state Σ0..1stringSub-unit of country (abbreviations ok)
... postalCode Σ0..1stringPostal code for area
Example General: 9132
... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Address.userequiredAddressUse
Address.typerequiredAddressType

Constraints

IdPathDetailsRequirements
ele-1AddressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Address.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Address.extension:languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Address.extension:languageMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Address.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.lineAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.line.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Address.line.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Address.line.extension:StreetnameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Address.line.extension:StreetnameMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Address.line.extension:Streetname.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.line.extension:HousenumberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Address.line.extension:HousenumberMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Address.line.extension:Housenumber.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.line.extension:PostboxAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Address.line.extension:PostboxMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Address.line.extension:Postbox.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.cityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.districtAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.stateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.postalCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.countryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())