0.1.0 - trial-use

This page is part of the IG Tooling by GKL (v0.1.0: DSTU 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

Data Type Profile: HL7® AT Core Address Profile

Official URL: https://gabriel0316.github.io/ig-tooling-pages/ig/ig-tooling/StructureDefinition/at-core-address Version: 0.1.0
Draft as of 2024-03-28 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 C0..*AddressAn 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
... line 0..*stringStreet name, number, direction & P.O. Box etc.
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... street 0..1stringName of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
.... streetNumber 0..1stringNumber of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
.... floorDoorNumber 0..1stringFloor and/or door number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
.... additionalInformation 0..1stringAdditional Information
URL: https://gabriel0316.github.io/ig-tooling-pages/ig/ig-tooling/StructureDefinition/at-core-ext-address-additionalInformation
... district 0..0
... period 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 C0..*AddressAn 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
... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... 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
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... street 0..1stringName of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
.... streetNumber 0..1stringNumber of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
.... floorDoorNumber 0..1stringFloor and/or door number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
.... additionalInformation 0..1stringAdditional Information
URL: https://gabriel0316.github.io/ig-tooling-pages/ig/ig-tooling/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())
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 C0..*AddressAn 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..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... text Σ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
.... street 0..1stringName of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
.... streetNumber 0..1stringNumber of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
.... floorDoorNumber 0..1stringFloor and/or door number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
.... additionalInformation 0..1stringAdditional Information
URL: https://gabriel0316.github.io/ig-tooling-pages/ig/ig-tooling/StructureDefinition/at-core-ext-address-additionalInformation
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... city Σ0..1stringName of city, town etc.
Example General: Erewhon
... state Σ0..1stringSub-unit of country (abbreviations ok)
... postalCode Σ0..1stringPostal code for area
Example General: 9132
... country Σ0..1stringCountry (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())
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 C0..*AddressAn 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
... line 0..*stringStreet name, number, direction & P.O. Box etc.
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... street 0..1stringName of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
.... streetNumber 0..1stringNumber of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
.... floorDoorNumber 0..1stringFloor and/or door number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
.... additionalInformation 0..1stringAdditional Information
URL: https://gabriel0316.github.io/ig-tooling-pages/ig/ig-tooling/StructureDefinition/at-core-ext-address-additionalInformation
... district 0..0
... period 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 C0..*AddressAn 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
... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... 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
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... street 0..1stringName of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
.... streetNumber 0..1stringNumber of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
.... floorDoorNumber 0..1stringFloor and/or door number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
.... additionalInformation 0..1stringAdditional Information
URL: https://gabriel0316.github.io/ig-tooling-pages/ig/ig-tooling/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())
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 C0..*AddressAn 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..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... text Σ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
.... street 0..1stringName of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
.... streetNumber 0..1stringNumber of the street
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
.... floorDoorNumber 0..1stringFloor and/or door number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
.... additionalInformation 0..1stringAdditional Information
URL: https://gabriel0316.github.io/ig-tooling-pages/ig/ig-tooling/StructureDefinition/at-core-ext-address-additionalInformation
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... city Σ0..1stringName of city, town etc.
Example General: Erewhon
... state Σ0..1stringSub-unit of country (abbreviations ok)
... postalCode Σ0..1stringPostal code for area
Example General: 9132
... country Σ0..1stringCountry (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())
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