eHealth Platform Federal Core Profiles
2.1.2 - STU1
eHealth Platform Federal Core Profiles, published by eHealth Platform. This guide is not an authorized publication; it is the continuous build for version 2.1.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/core/ and changes regularly. See the Directory of published versions
Official URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-address | Version: 2.1.2 | |||
Draft as of 2024-10-02 | 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
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) | |||||
extension | 0..* | Extension | Extension | |||||
Slices for extension | Content/Rules for all slices | |||||||
language | 0..1 | code | Human Language for the item URL: http://hl7.org/fhir/StructureDefinition/language Binding: CommonLanguages (preferred): IETF language tag
| |||||
line | 0..* | string | Street name, number, direction & P.O. Box etc. | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
Streetname | 0..* | string | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |||||
Housenumber | 0..* | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |||||
Postbox | 0..* | string | postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox | |||||
country | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |||||
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) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
language | 0..1 | code | Human Language for the item URL: http://hl7.org/fhir/StructureDefinition/language Binding: CommonLanguages (preferred): IETF language tag
| |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
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 | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
Streetname | 0..* | string | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |||||
Housenumber | 0..* | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |||||
Postbox | 0..* | string | postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox | |||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard |
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..1 | code | Human Language for the item URL: http://hl7.org/fhir/StructureDefinition/language Binding: CommonLanguages (preferred): IETF language tag
| |||||
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 | |||||
Streetname | 0..* | string | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |||||
Housenumber | 0..* | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |||||
Postbox | 0..* | string | postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox | |||||
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 |
Path | Conformance | ValueSet | URI |
Address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard |
This structure is derived from Address
Differential View
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) | |||||
extension | 0..* | Extension | Extension | |||||
Slices for extension | Content/Rules for all slices | |||||||
language | 0..1 | code | Human Language for the item URL: http://hl7.org/fhir/StructureDefinition/language Binding: CommonLanguages (preferred): IETF language tag
| |||||
line | 0..* | string | Street name, number, direction & P.O. Box etc. | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
Streetname | 0..* | string | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |||||
Housenumber | 0..* | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |||||
Postbox | 0..* | string | postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox | |||||
country | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |||||
Documentation for this format |
Key Elements 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) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
language | 0..1 | code | Human Language for the item URL: http://hl7.org/fhir/StructureDefinition/language Binding: CommonLanguages (preferred): IETF language tag
| |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
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 | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
Streetname | 0..* | string | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |||||
Housenumber | 0..* | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |||||
Postbox | 0..* | string | postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox | |||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard |
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..1 | code | Human Language for the item URL: http://hl7.org/fhir/StructureDefinition/language Binding: CommonLanguages (preferred): IETF language tag
| |||||
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 | |||||
Streetname | 0..* | string | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |||||
Housenumber | 0..* | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |||||
Postbox | 0..* | string | postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox | |||||
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 |
Path | Conformance | ValueSet | URI |
Address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard |
This structure is derived from Address
Other representations of profile: CSV, Excel, Schematron