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.extension:regionalSubdivisionCode.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 |
7. Address.extension:regionalSubdivisionCode.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to 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 |
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. |
Slicing | This element introduces a set of slices on Address.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
8. Address.extension:regionalSubdivisionCode.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-regional-subdivision-code |
9. Address.extension:regionalSubdivisionCode.value[x] | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Type | CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Slicing | This element introduces a set of slices on Address.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
10. Address.extension:regionalSubdivisionCode.value[x]:valueCodeableConcept | |
SliceName | valueCodeableConcept |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Binding | The codes SHALL be taken from RegionalSubdivisionCodes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
11. 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. |
Example | General:home |
12. 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 |
13. 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 |
14. 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 |
15. 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 |
16. 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 |
17. 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 |
18. 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 |
19. 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. |
20. 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-23T00:00:00+00:00"/> <end value="2010-07-01T00:00:00+00:00"/> </valuePeriod> |