This is an old version - please visit our new IG location
1.1.0 - published

This is an old version - please visit <a href='https://simplifier.net/guide/ImplementationGuideTheCoreBelgianFederalFHIRProfiles/Home'>our new IG location</a> - Local Development build (v1.1.0). See the Directory of published versions

Data Type Profile: Address core BE profile

Defining URL:https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-address
Version:1.0.0
Name:BeAddress
Title:Address core BE profile
Status:Active as of 2021-05-26T14:31:36+02:00
Definition:

Belgian 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 Platform
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)
... language 0..1codeHuman Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... line
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... iso21090-ADXP-streetName 0..*stringstreetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... valueString 0..1stringValue of extension
.... iso21090-ADXP-houseNumber 0..*stringhouseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... valueString 0..1stringValue of extension
.... iso21090-ADXP-postBox 0..*stringpostBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
..... valueString 0..1stringValue of extension
... country 0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)

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
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... language 0..1codeHuman 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)
.... 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
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
..... value[x] 1..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueString 0..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
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
..... value[x] 1..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueString 0..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
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox"
..... value[x] 1..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueString 0..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)
... language 0..1codeHuman Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... line
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... iso21090-ADXP-streetName 0..*stringstreetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... valueString 0..1stringValue of extension
.... iso21090-ADXP-houseNumber 0..*stringhouseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... valueString 0..1stringValue of extension
.... iso21090-ADXP-postBox 0..*stringpostBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
..... valueString 0..1stringValue of extension
... country 0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)

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
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... language 0..1codeHuman 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)
.... 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
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
..... value[x] 1..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueString 0..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
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
..... value[x] 1..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueString 0..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
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox"
..... value[x] 1..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueString 0..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