vkp-Address
The full profile documentation is published here: vkp-Address-v06
Overview
Address | Address | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
propertyinformation | I | 0..* | Extension(Complex) |
official | I | 0..1 | Extension(boolean) |
elock | I | 0..* | Extension(string) |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | codeBinding |
text | Σ | 0..1 | string |
line | Σ | 0..* | string |
id | 0..1 | string | |
extension | I | 0..* | Extension |
hint | I | 0..* | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
valueString | 0..1 | string | |
value | 0..1 | ||
city | Σ | 0..1 | string |
district | Σ | 0..1 | string |
state | Σ | 0..1 | string |
postalCode | Σ | 0..1 | string |
country | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
Dictionary
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. |
Cardinality | 0...* |
Comments | Note: address is for postal addresses, not physical locations. |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Address.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. |
Cardinality | 0...* |
Type | Extension |
Alias | 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 | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Address.extension:propertyinformation | |
Definition | Identification of a real property in Norway is defined using gårdsnummer, bruksnummer and kommunenummer. In addition real property can be rented out, the area of the real property that is rented is measured and is further identified by its festenummer. In addition some real property is split into sections identified by its seksjonsnummer. |
Cardinality | 0...* |
Type | Extension(Complex) |
Alias | extensions, user content |
Comments | real property identification |
Invariants |
|
Mappings |
|
Address.extension:official | |
Definition | Defines the concept of an officially registered address in Norway. Usually this will be the adress registered in "Folkeregisteret" for persons or "Enhetsregisteret" for organizations. |
Cardinality | 0...1 |
Type | Extension(boolean) |
Alias | 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 |
|
Mappings |
|
Address.extension:elock | |
Definition | Name of the e-lock system installed at the location, if no name is present there is no e-lock installed at the location. |
Cardinality | 0...* |
Type | Extension(string) |
Alias | 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 |
|
Mappings |
|
Address.use | |
Definition | The purpose of this address. Mapping of values to other Norwegian CodeSystems is documented in the implementation guide. In general the address used for visiting the person should have use "home" and type "physical" or "both". The "official" flag can be either true or false. |
Cardinality | 0...1 |
Type | code |
Binding | The use of an address AddressUse (required) |
Modifier | True |
Summary | 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. |
Invariants |
|
Examples | General home |
Mappings |
|
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. Mapping of values to other Norwegian CodeSystems is documented in the implementation guide. In general the address used for visiting the person should have use "home" and type "physical" or "both". The "official" flag can be either true or false. |
Cardinality | 0...1 |
Type | code |
Binding | The type of an address (physical / postal) AddressType (required) |
Summary | True |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Examples | General both |
Mappings |
|
Address.text | |
Definition | A full text representation of the address. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | A renderable, unencoded form. |
Comments | Can provide both a text representation and parts. |
Invariants |
|
Examples | General 137 Nowhere Street, Erewhon 9132 |
Mappings |
|
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. |
Cardinality | 0...* |
Type | string |
Summary | True |
Requirements | home | work | temp | old - purpose of this address. |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Examples | General 137 Nowhere Street |
Mappings |
|
Address.line.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Address.line.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. |
Cardinality | 0...* |
Type | Extension |
Alias | 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 | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Address.line.extension:hint | |
Definition | In VKP this extension is used to give additional information of how to locate the address when visiting the location. This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses). |
Cardinality | 0...* |
Type | Extension(string) |
Alias | 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 |
|
Mappings |
|
Address.line.extension:hint.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Address.line.extension:hint.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | 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 | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Address.line.extension:hint.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 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. |
Invariants |
|
Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator |
Mappings |
|
Address.line.extension:hint.valueString:valueString | |
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). |
Cardinality | 0...1 |
Type | string |
Invariants |
|
Mappings |
|
Address.line.value | |
Definition | Primitive value for string |
Cardinality | 0...1 |
Type | |
Address.city | |
Definition | When a postalcode is given the name of the city must be according to the official list of postalcodes used in Norway. The name of the city, town, village or other community or delivery center. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Municpality, by, poststed |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Examples | General Erewhon |
Mappings |
|
Address.district | |
Definition | Name of the county (norwegian "kommune"). If kommune number is required "eiendomsinformasjon" should be used. The name of the administrative area (county). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | County, kommune |
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. |
Invariants |
|
Examples | General Madison |
Mappings |
|
Address.state | |
Definition | Name of the norwegian "fylke"). If fylkes-number is required "eiendomsinformasjon" should be used with koded kommune-number. 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). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Province, Territory, fylke |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Address.postalCode | |
Definition | A postal code designating a region defined by the postal service. In Norway this is af four digit number defined by the norwegian postal service. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Zip, postnummer |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Examples | General 9132 |
Mappings |
|
Address.country | |
Definition | Country - a nation as commonly understood or generally accepted. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | ISO 3166 3 letter codes can be used in place of a full country name. |
Invariants |
|
Mappings |
|
Address.period | |
Definition | Time period when address was/is in use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Requirements | Allows addresses to be placed in historical context. |
Comments | This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. |
Invariants |
|
Examples | General { "start": "2010-03-23", "end": "2010-07-01" } |
Mappings |
|