Definitions for the ehealth-address Profile.
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 for postal addresses, not physical locations. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
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 |
3. Address.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
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:municipalityCode | |
SliceName | municipalityCode |
Definition | Optional Extension Element - found in all resources. |
Control | 0..1 |
Type | Extension(DanishMunicipalityCode) (Extension Type: Coding) |
5. Address.extension:regionalSubdivisionCode | |
SliceName | regionalSubdivisionCode |
Definition | Optional Extension Element - found in all resources. |
Control | 0..1 |
Type | Extension(DanishRegionalCode) (Extension Type: CodeableConcept) |
6. Address.use | |
Definition | The purpose of this address. |
Control | 1..1 |
Binding | The use of an address The codes SHALL be taken from AddressUse |
Type | code |
Is Modifier | true |
Requirements | Allows an appropriate address to be chosen from a list of many. |
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
Fixed Value | home |
Example | General:home |
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 type of an address (physical / postal) The codes SHALL be taken from AddressType |
Type | code |
Example | General:both |
8. Address.text | |
Definition | A full text representation of the address. |
Control | 0..1 |
Type | string |
Requirements | A renderable, unencoded form. |
Comments | Can provide both a text representation and parts. |
Example | General:137 Nowhere Street, Erewhon 9132 |
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 |
Requirements | home | work | temp | old - purpose of this address. |
Example | General:137 Nowhere Street |
10. Address.city | |
Definition | The name of the city, town, village or other community or delivery center. |
Control | 0..1 |
Type | string |
Alternate Names | Municpality |
Example | General:Erewhon |
11. Address.district | |
Definition | The name of the administrative area (county). |
Control | 0..0 |
Type | string |
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 |
12. 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 (i.e. US 2 letter state codes). |
Control | 0..0 |
Type | string |
Alternate Names | Province, Territory |
13. Address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Control | 0..1 |
Type | string |
Alternate Names | Zip |
Example | General:9132 |
14. Address.country | |
Definition | Country - a nation as commonly understood or generally accepted. |
Control | 0..1 |
Type | string |
Comments | ISO 3166 3 letter codes can be used in place of a full country name. |
15. Address.period | |
Definition | Time period when address was/is in use. |
Control | 0..1 |
Type | Period |
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> |