HL7® Austria FHIR® Core Implementation Guide
1.1.0 - STU2

HL7® Austria FHIR® Core Implementation Guide, published by HL7® Austria, TC FHIR®. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7Austria/HL7-AT-FHIR-Core-R4/ and changes regularly. See the Directory of published versions

Data Type Profile: HL7® AT Core Address Profile

Official URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-address Version: 1.1.0
Active as of 2024-11-17 Responsible: HL7® Austria, TC FHIR® Computable Name: HL7ATCoreAddress

HL7® Austria FHIR® Core Profile for address data in Austria. Note, this extension represents the common structure of address information within Austrian information systems. This extension does not restrict the documented information to Austrian adresses. Address information that does not fit into the given structure may be captured by Address Additional Information.

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 C 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
at-addr-1: If the extension for street name is used then the value for line must not be empty
at-addr-2: If the extension for street number is used then the value for line must not be empty
at-addr-3: If the extension for floor/door number is used then the value for line must not be empty
... Slices for extension Content/Rules for all slices
.... municipalityCode 0..1 string Address Municipality Code
URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-municipalityCode
... line 0..* string Street name, number, direction & P.O. Box etc.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... street 0..1 string Name of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... streetNumber 0..1 string Number of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... floorDoorNumber 0..1 string Floor and/or door number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
..... additionalInformation 0..1 string Additional Information
URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-additionalInformation
... district 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
at-addr-1errorAddressIf the extension for street name is used then the value for line must not be empty
: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue())
at-addr-2errorAddressIf the extension for street number is used then the value for line must not be empty
: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue())
at-addr-3errorAddressIf the extension for floor/door number is used then the value for line must not be empty
: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address C 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
at-addr-1: If the extension for street name is used then the value for line must not be empty
at-addr-2: If the extension for street number is used then the value for line must not be empty
at-addr-3: If the extension for floor/door number is used then the value for line must not be empty
... Slices for extension Content/Rules for all slices
.... municipalityCode 0..1 string Address Municipality Code
URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-municipalityCode
... 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
..... street 0..1 string Name of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... streetNumber 0..1 string Number of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... floorDoorNumber 0..1 string Floor and/or door number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
..... additionalInformation 0..1 string Additional Information
URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-additionalInformation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
at-addr-1errorAddressIf the extension for street name is used then the value for line must not be empty
: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue())
at-addr-2errorAddressIf the extension for street number is used then the value for line must not be empty
: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue())
at-addr-3errorAddressIf the extension for floor/door number is used then the value for line must not be empty
: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address C 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
at-addr-1: If the extension for street name is used then the value for line must not be empty
at-addr-2: If the extension for street number is used then the value for line must not be empty
at-addr-3: If the extension for floor/door number is used then the value for line must not be empty
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... municipalityCode 0..1 string Address Municipality Code
URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-municipalityCode
... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... 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
..... street 0..1 string Name of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... streetNumber 0..1 string Number of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... floorDoorNumber 0..1 string Floor and/or door number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
..... additionalInformation 0..1 string Additional Information
URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-additionalInformation
.... value 0..1 string Primitive value for string
Max Length:1048576
... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
... 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
at-addr-1errorAddressIf the extension for street name is used then the value for line must not be empty
: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue())
at-addr-2errorAddressIf the extension for street number is used then the value for line must not be empty
: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue())
at-addr-3errorAddressIf the extension for floor/door number is used then the value for line must not be empty
: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue())

Differential View

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address C 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
at-addr-1: If the extension for street name is used then the value for line must not be empty
at-addr-2: If the extension for street number is used then the value for line must not be empty
at-addr-3: If the extension for floor/door number is used then the value for line must not be empty
... Slices for extension Content/Rules for all slices
.... municipalityCode 0..1 string Address Municipality Code
URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-municipalityCode
... line 0..* string Street name, number, direction & P.O. Box etc.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... street 0..1 string Name of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... streetNumber 0..1 string Number of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... floorDoorNumber 0..1 string Floor and/or door number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
..... additionalInformation 0..1 string Additional Information
URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-additionalInformation
... district 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
at-addr-1errorAddressIf the extension for street name is used then the value for line must not be empty
: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue())
at-addr-2errorAddressIf the extension for street number is used then the value for line must not be empty
: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue())
at-addr-3errorAddressIf the extension for floor/door number is used then the value for line must not be empty
: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue())

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address C 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
at-addr-1: If the extension for street name is used then the value for line must not be empty
at-addr-2: If the extension for street number is used then the value for line must not be empty
at-addr-3: If the extension for floor/door number is used then the value for line must not be empty
... Slices for extension Content/Rules for all slices
.... municipalityCode 0..1 string Address Municipality Code
URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-municipalityCode
... 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
..... street 0..1 string Name of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... streetNumber 0..1 string Number of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... floorDoorNumber 0..1 string Floor and/or door number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
..... additionalInformation 0..1 string Additional Information
URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-additionalInformation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
at-addr-1errorAddressIf the extension for street name is used then the value for line must not be empty
: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue())
at-addr-2errorAddressIf the extension for street number is used then the value for line must not be empty
: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue())
at-addr-3errorAddressIf the extension for floor/door number is used then the value for line must not be empty
: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address C 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
at-addr-1: If the extension for street name is used then the value for line must not be empty
at-addr-2: If the extension for street number is used then the value for line must not be empty
at-addr-3: If the extension for floor/door number is used then the value for line must not be empty
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... municipalityCode 0..1 string Address Municipality Code
URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-municipalityCode
... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... 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
..... street 0..1 string Name of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... streetNumber 0..1 string Number of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... floorDoorNumber 0..1 string Floor and/or door number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
..... additionalInformation 0..1 string Additional Information
URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-additionalInformation
.... value 0..1 string Primitive value for string
Max Length:1048576
... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
... 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
at-addr-1errorAddressIf the extension for street name is used then the value for line must not be empty
: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue())
at-addr-2errorAddressIf the extension for street number is used then the value for line must not be empty
: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue())
at-addr-3errorAddressIf the extension for floor/door number is used then the value for line must not be empty
: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue())

 

Other representations of profile: CSV, Excel, Schematron