Belgium eHealth FHIR Core specifications
1.2.2 - CI Build
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. For a full list of available versions, see the Directory of published versions 
| 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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Address
This structure is derived from Address
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  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 | |
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 language | 0..* | code | Human Language for the item URL: http://hl7.org/fhir/StructureDefinition/language Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
| 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 | |
| iso21090-ADXP-streetName | 0..* | string | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |
 id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName" | |
 value[x] | 1..1 | string | Value of extension | |
| iso21090-ADXP-houseNumber | 0..* | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber" | |
| value[x] | 1..1 | string | Value of extension | |
| iso21090-ADXP-postBox | 0..* | string | postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox" | |
| value[x] | 1..1 | string | Value of extension | |
 value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| city | Σ | 0..1 | string | Name of city, town etc. 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 for area Example General: 9132 |
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
 period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| Documentation for this format | ||||
This structure is derived from Address
Differential View
This structure is derived from Address
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| language | 0..* | code | Human Language for the item URL: http://hl7.org/fhir/StructureDefinition/language Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
| 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 | |
| iso21090-ADXP-streetName | 0..* | string | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName" | |
| value[x] | 1..1 | string | Value of extension | |
| iso21090-ADXP-houseNumber | 0..* | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber" | |
| value[x] | 1..1 | string | Value of extension | |
| iso21090-ADXP-postBox | 0..* | string | postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox" | |
| value[x] | 1..1 | string | Value of extension | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| city | Σ | 0..1 | string | Name of city, town etc. 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 for area Example General: 9132 |
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| Address.use | required | AddressUse |
| Address.type | required | AddressType |
| Id | Path | Details | Requirements |
| ele-1 | Address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Address.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Address.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Address.extension:language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Address.extension:language | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Address.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Address.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Address.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Address.line | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Address.line.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Address.line.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Address.line.extension:Streetname | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Address.line.extension:Streetname | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Address.line.extension:Streetname.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Address.line.extension:Housenumber | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Address.line.extension:Housenumber | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Address.line.extension:Housenumber.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Address.line.extension:Postbox | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Address.line.extension:Postbox | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Address.line.extension:Postbox.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Address.city | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Address.district | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Address.state | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Address.postalCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Address.country | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Address.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
