eHealth Platform Federal Core Profiles
2.0.1 - STU1

This page is part of the HL7 Belgium FHIR Implementation Guide - Core profiles (v2.0.1: 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: BeAddress

Official URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-address Version: 2.0.1
Active as of 2022-09-13 Responsible: eHealth Platform Realm: BE Computable Name: BeAddress

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.

Usage:

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

Additional BindingsPurpose
AllLanguagesMax Binding
... 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
.... iso21090-ADXP-houseNumber 0..*stringhouseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
.... iso21090-ADXP-postBox 0..*stringpostBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox

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

Additional BindingsPurpose
AllLanguagesMax Binding

... 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
.... iso21090-ADXP-houseNumber 0..*stringhouseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
.... iso21090-ADXP-postBox 0..*stringpostBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
.... 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)
... extension 0..*ExtensionExtension
... language 0..1codeHuman Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... 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
.... iso21090-ADXP-houseNumber 0..*stringhouseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
.... iso21090-ADXP-postBox 0..*stringpostBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox

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

Additional BindingsPurpose
AllLanguagesMax Binding

... 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
.... iso21090-ADXP-houseNumber 0..*stringhouseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
.... iso21090-ADXP-postBox 0..*stringpostBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
.... 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