Estonian Base Implementation Guide
1.0.0 - ballot Estonia flag

Estonian Base Implementation Guide - Local Development build (v1.0.0). See the Directory of published versions

Data Type Profile: EEBase Address

Official URL: https://fhir.ee/StructureDefinition/ee-address Version: 1.0.0
Draft as of 2023-05-29 Computable Name: EEBaseAddress

EEBase Address Type

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)
... ads S0..1CodingADR-ID
URL: https://fhir.ee/StructureDefinition/ee-ads
Binding: ADS (required)
... ehak S0..1CodingEHAK code
URL: https://fhir.ee/StructureDefinition/ee-ehak
... use S1..1codehome | work | temp | old | billing - purpose of this address
... line
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... censusTract 0..1stringA geographic sub-unit delineated for demographic purposes.
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-censusTract
.... streetName 0..1stringStreet name
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
.... streetNameBase 0..1stringThe 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..1stringHouse number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
.... additionalLocator 0..1stringAdditional locator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
... city 0..1stringName of city, town etc.
... district 0..1stringAdministrative or political subdivision of a state or city
... state 0..1stringSub-unit of country
... postalCode 0..1stringPostal code for area
... country S1..1stringShould use a 2 digit ISO 3166 code
Binding: Iso316612 (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Address.countryrequiredIso316612
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... ads S0..1CodingADR-ID
URL: https://fhir.ee/StructureDefinition/ee-ads
Binding: ADS (required)
... ehak S0..1CodingEHAK code
URL: https://fhir.ee/StructureDefinition/ee-ehak
... use ?!SΣ1..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
... city Σ0..1stringName of city, town etc.
Example General: Erewhon
... district Σ0..1stringAdministrative or political subdivision of a state or city
Example General: Madison
... state Σ0..1stringSub-unit of country
... postalCode Σ0..1stringPostal code for area
Example General: 9132
... country SΣ1..1stringShould use a 2 digit ISO 3166 code
Binding: Iso316612 (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Address.userequiredAddressUse
Address.countryrequiredIso316612

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1idUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... ads S0..1CodingADR-ID
URL: https://fhir.ee/StructureDefinition/ee-ads
Binding: ADS (required)
... use ?!SΣ1..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
... text SΣ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
.... censusTract 0..1stringA geographic sub-unit delineated for demographic purposes.
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-censusTract
.... streetName 0..1stringStreet name
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
.... streetNameBase 0..1stringThe 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..1stringHouse number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
.... additionalLocator 0..1stringAdditional locator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... city Σ0..1stringName of city, town etc.
Example General: Erewhon
... district Σ0..1stringAdministrative or political subdivision of a state or city
Example General: Madison
... state Σ0..1stringSub-unit of country
... postalCode Σ0..1stringPostal code for area
Example General: 9132
... country SΣ1..1stringShould use a 2 digit ISO 3166 code
Binding: Iso316612 (required)
... 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

Terminology Bindings

PathConformanceValueSet
Address.userequiredAddressUse
Address.typerequiredAddressType
Address.countryrequiredIso316612

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

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)
... ads S0..1CodingADR-ID
URL: https://fhir.ee/StructureDefinition/ee-ads
Binding: ADS (required)
... ehak S0..1CodingEHAK code
URL: https://fhir.ee/StructureDefinition/ee-ehak
... use S1..1codehome | work | temp | old | billing - purpose of this address
... line
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... censusTract 0..1stringA geographic sub-unit delineated for demographic purposes.
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-censusTract
.... streetName 0..1stringStreet name
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
.... streetNameBase 0..1stringThe 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..1stringHouse number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
.... additionalLocator 0..1stringAdditional locator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
... city 0..1stringName of city, town etc.
... district 0..1stringAdministrative or political subdivision of a state or city
... state 0..1stringSub-unit of country
... postalCode 0..1stringPostal code for area
... country S1..1stringShould use a 2 digit ISO 3166 code
Binding: Iso316612 (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Address.countryrequiredIso316612

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... ads S0..1CodingADR-ID
URL: https://fhir.ee/StructureDefinition/ee-ads
Binding: ADS (required)
... ehak S0..1CodingEHAK code
URL: https://fhir.ee/StructureDefinition/ee-ehak
... use ?!SΣ1..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
... city Σ0..1stringName of city, town etc.
Example General: Erewhon
... district Σ0..1stringAdministrative or political subdivision of a state or city
Example General: Madison
... state Σ0..1stringSub-unit of country
... postalCode Σ0..1stringPostal code for area
Example General: 9132
... country SΣ1..1stringShould use a 2 digit ISO 3166 code
Binding: Iso316612 (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Address.userequiredAddressUse
Address.countryrequiredIso316612

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1idUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... ads S0..1CodingADR-ID
URL: https://fhir.ee/StructureDefinition/ee-ads
Binding: ADS (required)
... use ?!SΣ1..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
... text SΣ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
.... censusTract 0..1stringA geographic sub-unit delineated for demographic purposes.
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-censusTract
.... streetName 0..1stringStreet name
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
.... streetNameBase 0..1stringThe 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..1stringHouse number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
.... additionalLocator 0..1stringAdditional locator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... city Σ0..1stringName of city, town etc.
Example General: Erewhon
... district Σ0..1stringAdministrative or political subdivision of a state or city
Example General: Madison
... state Σ0..1stringSub-unit of country
... postalCode Σ0..1stringPostal code for area
Example General: 9132
... country SΣ1..1stringShould use a 2 digit ISO 3166 code
Binding: Iso316612 (required)
... 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

Terminology Bindings

PathConformanceValueSet
Address.userequiredAddressUse
Address.typerequiredAddressType
Address.countryrequiredIso316612

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron

Notes:

You should understand that district attribute may be used in the two roles:

  • county - subdivision of the state
  • city district - subdivision of the city

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"
    }
  ]

Meaning of address elements

NB! In the 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 the case of an Estonian address, the ADS extension with with values and services supported by Maaament are required.

Addresses in Estonia

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 ADS-i teist ja kolmandat taset ei ole võimalik ühtlaselt mäppida FHIR Address struktuuri. Mäppimise reeglid on järgmised:

  • state - Maakond. Vastab Maa-ameti ADS-iga liidestumise juhendis tasemele 1.
  • extension censusTract - Väikekoht (AÜ, SÜ, GÜ, vkt). Vastab Maa-ameti ADS-iga liidestumise juhendis tasemele 4.
  • extension streetName - Liikluspind (tee, tänav, puiestee, maantee). Vastab Maa-ameti ADS-iga liidestumise juhendis tasemele 5.
  • extension streetNameBase - Nimi (kohanimi, maaüksuse nimi). Vastab Maa-ameti ADS-iga liidestumise juhendis tasemele 6.
  • extension houseNumber - Aadressinumber (maaüksuse või hoone erilisand). Vastab Maa-ameti ADS-iga liidestumise juhendis tasemele 7.
  • extension additionalLocator - Korteri või muu hooneosa number. Vastab Maa-ameti ADS-iga liidestumise juhendis tasemele 8.
  • city ja district - seotakse teise ja kolmanda tasemega, kuid kuna district võib esineda mitmes rollis (nii maakonna kui linna töpsustusena) siis reeglid ei ole lineaarsed.
    • city - vaikimisi “Asula (küla, alevik, alev, vallasisene linn) või linnaosa. Vastab Maa-ameti ADS-iga liidestumise juhendis tasemele 3.”
    • district - vaikimis on omavalitsus (linn, vald). Vastab Maa-ameti ADS-iga liidestumise juhendis tasemele 2.

Kui vallade väliste linnade puhul tehakse erisusi ning linna kuvatakse city elemendis järgmistes olukordades:

  • kus ADS kolmadal tasemel ei ole haldusüksusi. Antud olukorras tegemist vallavälise linnaga millel ei ole sisemisi haldusjaotusi. Nt, ADR-ID: 100030 | Harju maakond, Maardu linn. Õige: 
    "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"
  }
]
  • kus ADS registris teisel ja kolmandal tasemel on sama nimetus. Nt, ADR-ID: 3020414 | Tartu maakond, Tartu linn, Tartu linn. Õige: 
    "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"
  }
]
  • Tallinna linnaosad kodeeritakse district elemendina. Nt, ADR-ID: 2103556 | Harju maakond, Tallinn, Kristiine linnaosa. Õige: 
    "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"
        }
      }
    ]          
  }
]
  • juhul kui muu linnal on haldusjaotused siis tuleb lähtuda ADS haldusjotusest. Nt, ADR-ID: 3020415 | Tartu maakond, Tartu linn, Tähtvere küla. Õige: 
    "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"
        }
      }
    ]     
]