FHIR Belgium Base IG
0.1.0 -

FHIR Belgium Base IG - Local Development build (v0.1.0). See the Directory of published versions

StructureDefinition: 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 separately.

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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... language I0..*codeHuman Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... type ΣI0..1codepostal | physical | both
Binding: AddressType (required)
Example General: both
... text ΣI0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line ΣI0..*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 I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... iso21090-ADXP-streetName I0..*stringstreetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
..... value[x] I1..1stringValue of extension
.... iso21090-ADXP-houseNumber I0..*stringhouseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
..... value[x] I1..1stringValue of extension
.... iso21090-ADXP-postBox I0..*stringpostBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox"
..... value[x] I1..1stringValue of extension
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... city ΣI0..1stringName of city, town etc.
Example General: Erewhon
... district ΣI0..1stringDistrict name (aka county)
Example General: Madison
... state ΣI0..1stringSub-unit of country (abbreviations ok)
... postalCode ΣI0..1stringPostal code for area
Example General: 9132
... country ΣI0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... period ΣI0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23T00:00:00+01:00","end":"2010-07-01T00:00:00+02:00"}

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... language I0..*codeHuman Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... type ΣI0..1codepostal | physical | both
Binding: AddressType (required)
Example General: both
... text ΣI0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line ΣI0..*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 I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... iso21090-ADXP-streetName I0..*stringstreetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
..... value[x] I1..1stringValue of extension
.... iso21090-ADXP-houseNumber I0..*stringhouseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
..... value[x] I1..1stringValue of extension
.... iso21090-ADXP-postBox I0..*stringpostBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox"
..... value[x] I1..1stringValue of extension
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... city ΣI0..1stringName of city, town etc.
Example General: Erewhon
... district ΣI0..1stringDistrict name (aka county)
Example General: Madison
... state ΣI0..1stringSub-unit of country (abbreviations ok)
... postalCode ΣI0..1stringPostal code for area
Example General: 9132
... country ΣI0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... period ΣI0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23T00:00:00+01:00","end":"2010-07-01T00:00:00+02:00"}

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
Address.userequiredAddressUse
Address.typerequiredAddressType

Constraints

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