0.1.0 - ci-build
igeMedicationat - Local Development build (v0.1.0). See the Directory of published versions
Definitions for the austrian-address-representation data type profile.
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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
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 |
Type | string |
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 manageable, 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.use | |
Definition | The purpose of this address. |
Control | 0..1 |
Binding | The codes SHALL be taken from AddressUse The use of an address |
Type | code |
Is Modifier | 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.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())) |
6. 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 |
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())) |
7. Address.line | |
Definition | This component contains the street name, street number, floor and/or door number or additonal information (e.g. street direction, P.O. Box number, delivery hints, and similar address information). This information can be split into structured values in the line-components each defined by international ISO extensions. If these extensions are used then the information they contain has to be written in a concatenated way in the line element itself as well. This makes the usage easier for systems which don't use address data in a structured way. |
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())) |
8. 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 |
9. 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:
|
10. Address.line.extension:street | |
SliceName | street |
Definition | Name of the street without the street number |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ADXP-streetName) (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()) |
11. Address.line.extension:streetNumber | |
SliceName | streetNumber |
Definition | Number of the street without the street name |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ADXP-houseNumber) (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()) |
12. Address.line.extension:floorDoorNumber | |
SliceName | floorDoorNumber |
Definition | Floor and/or door number |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ADXP-additionalLocator) (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.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 |
14. Address.city | |
Definition | 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())) |
15. Address.district | |
Definition | The name of the administrative area (county). |
Control | 0..0 |
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())) |
16. 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())) |
17. Address.postalCode | |
Definition | 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())) |
18. Address.country | |
Definition | Country - a nation as commonly understood or generally accepted. |
Control | 0..1 |
Type | string |
Summary | true |
Comments | ISO 3166 3 letter codes can 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())) |
19. Address.period | |
Definition | Time period when address was/is in use. |
Control | 0..0 |
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())) |