Estonian Base Implementation Guide
1.1.1 - trial-use
Estonian Base Implementation Guide, published by HL7 Estonia. This guide is not an authorized publication; it is the continuous build for version 1.1.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7EE/ig-ee-base/ and changes regularly. See the Directory of published versions
Official URL: https://fhir.ee/base/StructureDefinition/ee-address | Version: 1.1.1 | |||
Draft as of 2024-08-28 | Computable Name: EEBaseAddress |
An address expressed using postal conventions (as opposed to GPS or other location definition formats). This datatype may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. EEBase Address resource is developed in cooperation with Estonian Land Board. EEBase Address resource describes both Estonian and foreign addresses.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Address
Path | Conformance | ValueSet | URI |
Address.country | required | Iso316612http://hl7.org/fhir/ValueSet/iso3166-1-2 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) | |
Slices for extension | Content/Rules for all slices | |||
adsAdrId | S | 0..1 | Coding | ADS AdrId URL: https://fhir.ee/base/StructureDefinition/ee-ads-adr-id Binding: ADS AdrId (required) |
adsOid | S | 0..1 | Coding | ADS Oid URL: https://fhir.ee/base/StructureDefinition/ee-ads-oid Binding: ADS Oid (required) |
ehak | S | 0..1 | Coding | EHAK code URL: https://fhir.ee/base/StructureDefinition/ee-ehak |
official | S | 0..1 | boolean | Indicator of address of residency URL: http://hl7.org/fhir/StructureDefinition/address-official |
notice | S | 0..* | Coding | Address notices and warnings URL: https://fhir.ee/base/StructureDefinition/ee-address-notice |
use | ?!SΣ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home |
text | SΣ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
district | Σ | 0..1 | string | Administrative or political subdivision of a state or city Example General: Madison |
state | Σ | 0..1 | string | Sub-unit of country |
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 |
country | SΣ | 1..1 | string | Should use a 2 digit ISO 3166 code Binding: Iso316612 (required) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|5.0.0 from the FHIR Standard | |
Address.country | required | Iso316612http://hl7.org/fhir/ValueSet/iso3166-1-2 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
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 | id | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
adsAdrId | S | 0..1 | Coding | ADS AdrId URL: https://fhir.ee/base/StructureDefinition/ee-ads-adr-id Binding: ADS AdrId (required) |
adsOid | S | 0..1 | Coding | ADS Oid URL: https://fhir.ee/base/StructureDefinition/ee-ads-oid Binding: ADS Oid (required) |
ehak | S | 0..1 | Coding | EHAK code URL: https://fhir.ee/base/StructureDefinition/ee-ehak |
official | S | 0..1 | boolean | Indicator of address of residency URL: http://hl7.org/fhir/StructureDefinition/address-official |
notice | S | 0..* | Coding | Address notices and warnings URL: https://fhir.ee/base/StructureDefinition/ee-address-notice |
use | ?!SΣ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
text | SΣ | 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 | |
censusTract | 0..1 | string | A geographic sub-unit delineated for demographic purposes. URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-censusTract | |
streetName | 0..1 | string | Street name URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |
streetNameBase | 0..1 | string | The base name of a roadway or artery recognized by a municipality (excluding street type and direction). URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameBase | |
houseNumber | 0..1 | string | House number URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |
additionalLocator | 0..1 | string | Additional locator URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator | |
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 | Administrative or political subdivision of a state or city Example General: Madison |
state | Σ | 0..1 | string | Sub-unit of country |
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 |
country | SΣ | 1..1 | string | Should use a 2 digit ISO 3166 code Binding: Iso316612 (required) |
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|5.0.0 from the FHIR Standard | |
Address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|5.0.0 from the FHIR Standard | |
Address.country | required | Iso316612http://hl7.org/fhir/ValueSet/iso3166-1-2 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Address
Summary
Mandatory: 2 elements
Must-Support: 8 elements
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Address
Path | Conformance | ValueSet | URI |
Address.country | required | Iso316612http://hl7.org/fhir/ValueSet/iso3166-1-2 from the FHIR Standard |
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 | Content/Rules for all slices | |||
adsAdrId | S | 0..1 | Coding | ADS AdrId URL: https://fhir.ee/base/StructureDefinition/ee-ads-adr-id Binding: ADS AdrId (required) |
adsOid | S | 0..1 | Coding | ADS Oid URL: https://fhir.ee/base/StructureDefinition/ee-ads-oid Binding: ADS Oid (required) |
ehak | S | 0..1 | Coding | EHAK code URL: https://fhir.ee/base/StructureDefinition/ee-ehak |
official | S | 0..1 | boolean | Indicator of address of residency URL: http://hl7.org/fhir/StructureDefinition/address-official |
notice | S | 0..* | Coding | Address notices and warnings URL: https://fhir.ee/base/StructureDefinition/ee-address-notice |
use | ?!SΣ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home |
text | SΣ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
district | Σ | 0..1 | string | Administrative or political subdivision of a state or city Example General: Madison |
state | Σ | 0..1 | string | Sub-unit of country |
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 |
country | SΣ | 1..1 | string | Should use a 2 digit ISO 3166 code Binding: Iso316612 (required) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|5.0.0 from the FHIR Standard | |
Address.country | required | Iso316612http://hl7.org/fhir/ValueSet/iso3166-1-2 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
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 | id | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
adsAdrId | S | 0..1 | Coding | ADS AdrId URL: https://fhir.ee/base/StructureDefinition/ee-ads-adr-id Binding: ADS AdrId (required) |
adsOid | S | 0..1 | Coding | ADS Oid URL: https://fhir.ee/base/StructureDefinition/ee-ads-oid Binding: ADS Oid (required) |
ehak | S | 0..1 | Coding | EHAK code URL: https://fhir.ee/base/StructureDefinition/ee-ehak |
official | S | 0..1 | boolean | Indicator of address of residency URL: http://hl7.org/fhir/StructureDefinition/address-official |
notice | S | 0..* | Coding | Address notices and warnings URL: https://fhir.ee/base/StructureDefinition/ee-address-notice |
use | ?!SΣ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
text | SΣ | 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 | |
censusTract | 0..1 | string | A geographic sub-unit delineated for demographic purposes. URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-censusTract | |
streetName | 0..1 | string | Street name URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |
streetNameBase | 0..1 | string | The base name of a roadway or artery recognized by a municipality (excluding street type and direction). URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameBase | |
houseNumber | 0..1 | string | House number URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |
additionalLocator | 0..1 | string | Additional locator URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator | |
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 | Administrative or political subdivision of a state or city Example General: Madison |
state | Σ | 0..1 | string | Sub-unit of country |
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 |
country | SΣ | 1..1 | string | Should use a 2 digit ISO 3166 code Binding: Iso316612 (required) |
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|5.0.0 from the FHIR Standard | |
Address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|5.0.0 from the FHIR Standard | |
Address.country | required | Iso316612http://hl7.org/fhir/ValueSet/iso3166-1-2 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Address
Summary
Mandatory: 2 elements
Must-Support: 8 elements
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
You should understand that district attribute may be used in the two roles:
Example of usage as county
"address": [
{
"use": "temp",
"line": [
"5601 Universal Blvd"
],
"city": "Orlando",
"district": "Orange County",
"state": "FL",
"postalCode": "32819",
"country": "US"
}
]
Example of usage as city district
"address": [
{
"use": "work",
"line": [
"Pl. de l'Opéra"
],
"district": "The 9th district",
"city": "Paris",
"state": "Île-de-France region",
"postalCode": "75009",
"country": "FR"
}
]
NB! In case of an address, all fields provide informational content only, these fields may not be used for statistics or similar operations. The only exceptions that are strictly typed attributes: 1) country and 2) ADS extension. In case of an Estonian address, the ADS extension with values and services supported by Estonian Land Board is required.
Tuleb arvestada, et ADS omab piisavalt keerulist struktuuri, mis lähtub administratiivses kuuluvusest, samas Address andmetüüp lähtub postikujust. Administratiivse ja postikuju erinevuste tõttu ei ole võimalik ADS-i teist ja kolmandat taset ühtlaselt mäppida FHIR Address struktuuri. Mäppimise reeglid on järgmised:
Vallaväliste linnade puhul tehakse erisusi ning linna kuvatakse city elemendis järgmistes olukordades:
"address": [
{
"use": "work",
"line": [
"Kallasmaa 1"
],
"city": "Maardu linn",
"state": "Harju maakond",
"postalCode": "74111",
"country": "EE",
"text": "Harju maakond, Maardu linn, Kallasmaa 1",
"extension" : [
{
"url" : "https://fhir.ee/StructureDefinition/ee-ads",
"valueCoding" : {
"code" : "100030"
}
}
]
}
]
Vale:
"address": [
{
"use": "work",
"line": [
"Kallasmaa 1"
],
"district": "Maardu linn",
"state": "Harju maakond",
"postalCode": "74111",
"country": "EE"
}
]
"address": [
{
"use": "home",
"line": [
"K. Veeberi tn 4"
],
"city": "Tartu linn",
"state": "Tartu maakond",
"postalCode": "74111",
"country": "EE",
"text": "Tartu maakond, Tartu linn, K. Veeberi tn 4",
"extension" : [
{
"url" : "https://fhir.ee/StructureDefinition/ee-ads",
"valueCoding" : {
"code" : "3020414"
}
}
]
}
]
Vale:
"address": [
{
"use": "home",
"line": [
"K. Veeberi tn 4"
],
"city": "Tartu linn",
"district": "Tartu linn",
"state": "Tartu maakond",
"postalCode": "74111",
"country": "EE"
}
]
"address": [
{
"use": "home",
"line": [
"Staap"
],
"city": "Tallinn",
"district": "Kristiine linnaosa",
"state": "Harju maakond",
"postalCode": "74111",
"country": "EE",
"text": "Harju maakond, Tallinn, Kristiine linnaosa",
"extension" : [
{
"url" : "https://fhir.ee/StructureDefinition/ee-ads",
"valueCoding" : {
"code" : "2103556"
}
}
]
}
]
"address": [
{
"use": "work",
"line": [
"Gardest OÜ"
],
"district": "Tartu linn",
"city": "Tähtvere küla",
"state": "Tartu maakond",
"postalCode": "74111",
"country": "EE",
"text": "Tartu maakond, Tartu linn, Tähtvere küla",
"extension" : [
{
"url" : "https://fhir.ee/StructureDefinition/ee-ads",
"valueCoding" : {
"code" : "3020415"
}
}
]
]