Estonian Base Implementation Guide
1.0.0 - ballot
Estonian Base Implementation Guide
1.0.0 - ballot
Estonian Base Implementation Guide - Local Development build (v1.0.0). See the Directory of published versions
| Draft as of 2023-05-29 |
Definitions for the ee-address data type profile.
Guidance on how to interpret the contents of this table can be found here.
| 1. Address | |
| 2. Address.extension:ads | |
| SliceName | ads |
| Control | 0..1 |
| Type | Extension(ExtensionEEBaseADS) (Extension Type: Coding) |
| Must Support | true |
| 3. Address.extension:ehak | |
| SliceName | ehak |
| Control | 0..1 |
| Type | Extension(ExtensionEEBaseEHAK) (Extension Type: Coding) |
| Must Support | true |
| 4. Address.use | |
| Control | 10..1 |
| Must Support | true |
| 5. Address.text | |
| Must Support | true |
| 6. Address.line | |
| Control | 0..? |
| 7. Address.line.extension | |
| Control | 0..? |
| Slicing | This element introduces a set of slices on Address.line.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 8. Address.line.extension:censusTract | |
| SliceName | censusTract |
| Definition | Väikekoht (AÜ, SÜ, GÜ, vkt). Vastab Maa-ameti ADS-iga liidestumise juhendis tasemele 4. |
| Control | 0..1 |
| Type | Extension(ADXPCensusTract) (Extension Type: string) |
| 9. Address.line.extension:streetName | |
| SliceName | streetName |
| Definition | Liikluspind (tee, tänav, puiestee, maantee). Vastab Maa-ameti ADS-iga liidestumise juhendis tasemele 5. |
| Control | 0..1 |
| Type | Extension(ADXPStreetName) (Extension Type: string) |
| 10. Address.line.extension:streetNameBase | |
| SliceName | streetNameBase |
| Definition | Nimi (kohanimi, maaüksuse nimi). Vastab Maa-ameti ADS-iga liidestumise juhendis tasemele 6. |
| Control | 0..1 |
| Type | Extension(ADXPStreetNameBase) (Extension Type: string) |
| 11. Address.line.extension:houseNumber | |
| SliceName | houseNumber |
| Definition | Aadressinumber (maaüksuse või hoone erilisand). Vastab Maa-ameti ADS-iga liidestumise juhendis tasemele 7. |
| Control | 0..1 |
| Type | Extension(ADXPHouseNumber) (Extension Type: string) |
| 12. Address.line.extension:additionalLocator | |
| SliceName | additionalLocator |
| Definition | Korteri või muu hooneosa number. Vastab Maa-ameti ADS-iga liidestumise juhendis tasemele 8. |
| Control | 0..1 |
| Type | Extension(ADXPAdditionalLocator) (Extension Type: string) |
| 13. Address.city | |
| Definition | Asula (küla, alevik, alev, vallasisene linn) või linnaosa. Vastab Maa-ameti ADS-iga liidestumise juhendis tasemele 3. The name of the city, town, suburb, village or other community or delivery center. |
| 14. Address.district | |
| 15. Address.state | |
| 16. Address.postalCode | |
| Definition | Postiindeks A postal code designating a region defined by the postal service. |
| 17. Address.country | |
| Definition | Riigi kood (lubatud ISO-3166-2 koodid) Country - a nation as commonly understood or generally accepted. |
| Control | 10..1 |
| Binding | The codes SHALL be taken from Iso316612For codes, see (unbound) |
| Must Support | true |
Guidance on how to interpret the contents of this table can be found here.
| 1. Address | |
| Definition | An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type 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. The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address. |
| Control | 0..* |
| Comments | Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 2. Address.extension:ads | |
| SliceName | ads |
| Definition | Aadressiandmete süsteem (ADS) koosneb aadressiandmete süsteemi infosüsteemist ning erinevatest nõuetest. ADS-i eesmärk on tagada ühene aadressiandmete kogumine, registreerimine, töötlemine, säilitamine, identifitseerimine ning töötlemise funktsioonide ühetaoline korraldamine. |
| Control | 0..1 |
| Type | Extension(ExtensionEEBaseADS) (Extension Type: Coding) |
| Must Support | true |
| Summary | false |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 3. Address.extension:ehak | |
| SliceName | ehak |
| Definition | Eesti haldus- ja asustusjaotuse klassifikaator (EHAK) on ette nähtud territoriaalse paiknemise tähistamiseks. Igale klassifitseerimisobjektile on antud unikaalne neljakohaline kood ja näidatud on objekti nimi ning rööpnimi (kui see on olemas). |
| Control | 0..1 |
| Type | Extension(ExtensionEEBaseEHAK) (Extension Type: Coding) |
| Must Support | true |
| Summary | false |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 4. Address.use | |
| Definition | The purpose of this address. |
| Control | 10..1 |
| Binding | The codes SHALL be taken from AddressUse The use of an address (home / work / etc.). |
| Type | code |
| Is Modifier | true |
| Must Support | true |
| Summary | true |
| Requirements | Allows an appropriate address to be chosen from a list of many. |
| Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
| Example | General:home |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 5. Address.text | |
| Definition | Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. |
| Control | 0..1 |
| Type | string |
| Must Support | true |
| Summary | true |
| Requirements | A renderable, unencoded form. |
| Comments | Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
| Example | General:137 Nowhere Street, Erewhon 9132 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 6. Address.city | |
| Definition | Asula (küla, alevik, alev, vallasisene linn) või linnaosa. Vastab Maa-ameti ADS-iga liidestumise juhendis tasemele 3. The name of the city, town, suburb, village or other community or delivery center. |
| Control | 0..1 |
| Type | string |
| Summary | true |
| Alternate Names | Municpality |
| Example | General:Erewhon |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 7. Address.district | |
| Definition | The name of the administrative area (county). |
| Control | 0..1 |
| Type | string |
| Summary | true |
| Alternate Names | County |
| Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. |
| Example | General:Madison |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 8. Address.state | |
| Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). |
| Control | 0..1 |
| Type | string |
| Summary | true |
| Alternate Names | Province, Territory |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 9. Address.postalCode | |
| Definition | Postiindeks A postal code designating a region defined by the postal service. |
| Control | 0..1 |
| Type | string |
| Summary | true |
| Alternate Names | Zip |
| Example | General:9132 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 10. Address.country | |
| Definition | Riigi kood (lubatud ISO-3166-2 koodid) Country - a nation as commonly understood or generally accepted. |
| Control | 10..1 |
| Binding | The codes SHALL be taken from Iso316612For codes, see (unbound) |
| Type | string |
| Must Support | true |
| Summary | true |
| Comments | ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here.
| 1. Address | |
| Definition | An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type 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. The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address. |
| Control | 0..* |
| Comments | Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). |
| 2. Address.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 3. Address.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Address.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 4. Address.extension:ads | |
| SliceName | ads |
| Definition | Aadressiandmete süsteem (ADS) koosneb aadressiandmete süsteemi infosüsteemist ning erinevatest nõuetest. ADS-i eesmärk on tagada ühene aadressiandmete kogumine, registreerimine, töötlemine, säilitamine, identifitseerimine ning töötlemise funktsioonide ühetaoline korraldamine. |
| Control | 0..1 |
| Type | Extension(ExtensionEEBaseADS) (Extension Type: Coding) |
| Must Support | true |
| Summary | false |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 5. Address.extension:ehak | |
| SliceName | ehak |
| Definition | Eesti haldus- ja asustusjaotuse klassifikaator (EHAK) on ette nähtud territoriaalse paiknemise tähistamiseks. Igale klassifitseerimisobjektile on antud unikaalne neljakohaline kood ja näidatud on objekti nimi ning rööpnimi (kui see on olemas). |
| Control | 0..1 |
| Type | Extension(ExtensionEEBaseEHAK) (Extension Type: Coding) |
| Must Support | true |
| Summary | false |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 6. Address.use | |
| Definition | The purpose of this address. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from AddressUse The use of an address (home / work / etc.) |
| Type | code |
| Is Modifier | true |
| Must Support | true |
| Summary | true |
| Requirements | Allows an appropriate address to be chosen from a list of many. |
| Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
| Example | General:home |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 7. Address.type | |
| Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AddressType The type of an address (physical / postal) |
| Type | code |
| Summary | true |
| Comments | The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). |
| Example | General:both |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 8. Address.text | |
| Definition | Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. |
| Control | 0..1 |
| Type | string |
| Must Support | true |
| Summary | true |
| Requirements | A renderable, unencoded form. |
| Comments | Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
| Example | General:137 Nowhere Street, Erewhon 9132 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 9. Address.line | |
| Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
| Control | 0..* |
| Type | string |
| Summary | true |
| Example | General:137 Nowhere Street |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 10. Address.line.id | |
| Definition | unique id for the element within a resource (for internal references) |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 11. Address.line.extension | |
| Definition | An Extension |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Address.line.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 12. Address.line.extension:censusTract | |
| SliceName | censusTract |
| Definition | Väikekoht (AÜ, SÜ, GÜ, vkt). Vastab Maa-ameti ADS-iga liidestumise juhendis tasemele 4. |
| Control | 0..1 |
| Type | Extension(ADXPCensusTract) (Extension Type: string) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 13. Address.line.extension:streetName | |
| SliceName | streetName |
| Definition | Liikluspind (tee, tänav, puiestee, maantee). Vastab Maa-ameti ADS-iga liidestumise juhendis tasemele 5. |
| Control | 0..1 |
| Type | Extension(ADXPStreetName) (Extension Type: string) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 14. Address.line.extension:streetNameBase | |
| SliceName | streetNameBase |
| Definition | Nimi (kohanimi, maaüksuse nimi). Vastab Maa-ameti ADS-iga liidestumise juhendis tasemele 6. |
| Control | 0..1 |
| Type | Extension(ADXPStreetNameBase) (Extension Type: string) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 15. Address.line.extension:houseNumber | |
| SliceName | houseNumber |
| Definition | Aadressinumber (maaüksuse või hoone erilisand). Vastab Maa-ameti ADS-iga liidestumise juhendis tasemele 7. |
| Control | 0..1 |
| Type | Extension(ADXPHouseNumber) (Extension Type: string) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 16. Address.line.extension:additionalLocator | |
| SliceName | additionalLocator |
| Definition | Korteri või muu hooneosa number. Vastab Maa-ameti ADS-iga liidestumise juhendis tasemele 8. |
| Control | 0..1 |
| Type | Extension(ADXPAdditionalLocator) (Extension Type: string) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 17. Address.line.value | |
| Definition | The actual value |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Max Length | 1048576 |
| 18. Address.city | |
| Definition | Asula (küla, alevik, alev, vallasisene linn) või linnaosa. Vastab Maa-ameti ADS-iga liidestumise juhendis tasemele 3. |
| Control | 0..1 |
| Type | string |
| Summary | true |
| Alternate Names | Municpality |
| Example | General:Erewhon |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 19. Address.district | |
| Definition | The name of the administrative area (county). |
| Control | 0..1 |
| Type | string |
| Summary | true |
| Alternate Names | County |
| Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. |
| Example | General:Madison |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 20. Address.state | |
| Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). |
| Control | 0..1 |
| Type | string |
| Summary | true |
| Alternate Names | Province, Territory |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 21. Address.postalCode | |
| Definition | Postiindeks |
| Control | 0..1 |
| Type | string |
| Summary | true |
| Alternate Names | Zip |
| Example | General:9132 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 22. Address.country | |
| Definition | Riigi kood (lubatud ISO-3166-2 koodid) |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Iso316612 |
| Type | string |
| Must Support | true |
| Summary | true |
| Comments | ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 23. Address.period | |
| Definition | Time period when address was/is in use. |
| Control | 0..1 |
| Type | Period |
| Summary | true |
| Requirements | Allows addresses to be placed in historical context. |
| Example | General:<valuePeriod xmlns="http://hl7.org/fhir"> <start value="2010-03-23"/> <end value="2010-07-01"/> </valuePeriod> |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |