HL7® Austria FHIR® Core Implementation Guide
1.1.0 - STU2
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
| Official URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-address | Version: 1.1.0 | |||
| Active as of 2024-12-19 | 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Address
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  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 | |||
 period |
0..0 | |||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| at-addr-1 | error | Address | If 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-2 | error | Address | If 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-3 | error | Address | If 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()) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address |
C | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home |
| line |
Σ | 0..* | string | Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| street |
0..1 | string | Name of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| streetNumber |
0..1 | string | Number of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| floorDoorNumber |
0..1 | string | Floor and/or door number URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| additionalInformation |
0..1 | string | Additional Information URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-additionalInformation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| at-addr-1 | error | Address | If 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-2 | error | Address | If 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-3 | error | Address | If 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()) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| type |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
| 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) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | |
| Address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| at-addr-1 | error | Address | If 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-2 | error | Address | If 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-3 | error | Address | If 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()) |
This structure is derived from Address
Summary
Prohibited: 2 elements
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Address
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | |||
| period |
0..0 | |||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| at-addr-1 | error | Address | If 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-2 | error | Address | If 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-3 | error | Address | If 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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address |
C | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home |
| line |
Σ | 0..* | string | Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| street |
0..1 | string | Name of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| streetNumber |
0..1 | string | Number of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| floorDoorNumber |
0..1 | string | Floor and/or door number URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| additionalInformation |
0..1 | string | Additional Information URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-additionalInformation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| at-addr-1 | error | Address | If 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-2 | error | Address | If 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-3 | error | Address | If 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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| type |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
| 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) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | |
| Address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| at-addr-1 | error | Address | If 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-2 | error | Address | If 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-3 | error | Address | If 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()) |
This structure is derived from Address
Summary
Prohibited: 2 elements
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron