0.1.7 - ci-build
EgdeEHG_IG - Local Development build (v0.1.7). See the Directory of published versions
Draft as of 2023-03-24 |
Definitions for the ehg-no-Address data type profile.
Guidance on how to interpret the contents of this table can be found here.
1. Address | |
2. Address.line | |
Must Support | true |
3. Address.city | |
Must Support | true |
4. Address.postalCode | |
Must Support | true |
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). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
2. Address.extension:official | |
SliceName | 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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(NoBasisAddressOfficial) (Extension Type: boolean) |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content, offisiell adresse |
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()) |
3. Address.extension:urbanDistrict | |
SliceName | urbanDistrict |
Definition | The name and number of the of the urban district of this address. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(NoBasisUrbanDistrict) (Extension Type: Coding) |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content, bydel, urban district |
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()) |
4. Address.extension:propertyInformation | |
SliceName | 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 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 | This element is affected by the following invariants: ele-1 |
Type | Extension(NoBasisPropertyinformation) (Complex Extension) |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content |
Invariants | Defined on this element ele-1: (: ) ext-1: (: ) |
5. 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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from AddressUse The use of an address. |
Type | code |
Is Modifier | true |
Standards Status | Normative (from Normative) |
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())) |
6. 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..* This element is affected by the following invariants: ele-1 |
Type | string |
Must Support | true |
Summary | true |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
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())) |
7. 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. The name of the city, town, suburb, village or other community or delivery center. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Must Support | true |
Summary | true |
Alternate Names | Municpality, by, poststed |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
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())) |
8. 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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Must Support | true |
Summary | true |
Alternate Names | Zip, postnummer |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
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())) |
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. |
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..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standards Status | Normative (from Normative) |
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.extension:official | |
SliceName | 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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(NoBasisAddressOfficial) (Extension Type: boolean) |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content, offisiell adresse |
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()) |
5. Address.extension:urbanDistrict | |
SliceName | urbanDistrict |
Definition | The name and number of the of the urban district of this address. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(NoBasisUrbanDistrict) (Extension Type: Coding) |
Standards Status | Normative (from Normative) |
Alternate Names | extensions, user content, bydel, urban district |
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()) |
6. Address.extension:propertyInformation | |
SliceName | 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 |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(NoBasisPropertyinformation) (Complex Extension) |
Standards Status | Normative (from Normative) |
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()) |
7. 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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from AddressUse The use of an address |
Type | code |
Is Modifier | true |
Standards Status | Normative (from Normative) |
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())) |
8. 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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from AddressType The type of an address (physical / postal) |
Type | code |
Standards Status | Normative (from Normative) |
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())) |
9. 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 This element is affected by the following invariants: ele-1 |
Type | string |
Standards Status | Normative (from Normative) |
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())) |
10. 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..* This element is affected by the following invariants: ele-1 |
Type | string |
Must Support | true |
Summary | true |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
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())) |
11. 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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Must Support | true |
Summary | true |
Alternate Names | Municpality, by, poststed |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
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())) |
12. Address.district | |
Definition | Name of the county (norwegian "kommune"). The name of the administrative area (county). |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Standards Status | Normative (from Normative) |
Summary | true |
Alternate Names | 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. |
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())) |
13. Address.district.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. |
14. Address.district.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..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standards Status | Normative (from Normative) |
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.district.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
15. Address.district.extension:municipalitycode | |
SliceName | municipalitycode |
Definition | Coded value for municipality/county Norwegian kommune |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(NoBasisMunicipalitycode) (Extension Type: Coding) |
Standards Status | Normative (from Normative) |
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()) |
16. Address.district.value | |
Definition | Primitive value for string |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Max Length | 1048576 |
17. 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). |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Standards Status | Normative (from Normative) |
Summary | true |
Alternate Names | Province, Territory, fylke |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
18. 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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Must Support | true |
Summary | true |
Alternate Names | Zip, postnummer |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
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())) |
19. Address.country | |
Definition | Country - a nation as commonly understood or generally accepted. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Standards Status | Normative (from Normative) |
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())) |
20. Address.period | |
Definition | Time period when address was/is in use. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Period |
Standards Status | Normative (from Normative) |
Summary | true |
Requirements | Allows addresses to be placed in historical context. |
Comments | 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"). Period is not used for a duration (a measure of elapsed time). See Duration. |
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())) per-1: If present, start SHALL have a lower value than end (: start.hasValue().not() or end.hasValue().not() or (start <= end)) |