NL Core Address
This extension is used in the following profiles:
The canonical URL for this profile is:
http://fhir.nl/fhir/StructureDefinition/nl-core-address
| Address | 0..* | Address | Element Id
Address Address information Alternate namesAdresInformatie DefinitionThere is a variety of postal address formats defined around the world. This format defines a superset that is the basis for all addresses around the world and adds all relevant components to express Dutch addresses. A Dutch Address is a proper FHIR Address. Systems that do not understand any of the extensions, will be able to render and work with a Dutch address. Dutch addresses make certain address parts separately communicable. These parts are required for use in true Dutch systems when dealing with Dutch addresses, but may not have value for international systems when information gets sent abroad. To have true compatibility an implementer SHOULD use the core Address parts as intended. To have addresses work for Dutch context, the implementer SHOULD in addition use the extension elements. The HCIM defines certain address types in the AdresSoortCodelijst. These do not all have a one to one mapping in the FHIR Address datatype. The following explains how to deal with that. In addition, there are the ConceptMaps http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressUse and http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressType to define this relationship HCIM Postal Address maps to Address.type 'postal'; HCIM Primary Home Address maps to Address.extension:official 'true' + Address.use 'home' + Address.use.extension 'HP'; HCIM Visit Address (Woon-/verblijfadres) maps to Address.use 'home' + Address.type 'physical' + Address.use.extension 'PHYS'; HCIM Temporary Address maps to Address.use 'temp'; HCIM Work Place Address maps to Address.use 'work'; HCIM Vacation Home Address maps to Address.use 'temp' + Address.use.extension 'HV'. If Address.type is "both" then this is to be understood as a dual purpose address (postal and physical). Systems that support importing it like this are encouraged to do so, otherwise they may need to import this as two separate addresses. Note: address is for postal addresses, not physical locations.
Example of a vacation home address
{
"extension": [
{
"url": "http://fhir.nl/fhir/StructureDefinition/nl-core-address-official",
"valueBoolean": false
}
],
"use": "temp",
"_use": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-AD-use",
"valueCode": "HV"
}
]
},
"line": [
"Binnenkant 12A Hoog"
],
"_line": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName",
"valueString": "Binnenkant"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber",
"valueString": "12"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix",
"valueString": "A"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID",
"valueString": "Hoog"
}
]
}
],
"city": "Amsterdam",
"state": "NH",
"postalCode": "1000AA",
"country": "NLD"
}
Example of a primary home address
{
"extension": [
{
"url": "http://fhir.nl/fhir/StructureDefinition/nl-core-address-official",
"valueBoolean": true
}
],
"use": "home",
"line": [
"Binnenkant to 10"
],
"_line": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName",
"valueString": "Binnenkant"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator",
"valueString": "to"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber",
"valueString": "10"
}
]
}
],
"city": "Amsterdam",
"state": "NH",
"postalCode": "1001AA",
"country": "NLD"
}
Mappings
|
|
| extension | 0..* | Extension | Element Id
Address.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
|
|
| official | 0..1 | Extension(boolean) | Element Id
Address.extension:official Mark an address as an 'officially registered' address. Alternate namesextensions, user content, Markeer een adres als een 'officieel geregistreerd adres. DefinitionMark an address as an 'officially registered' address. In Dutch context that means it is registered in the Basisregistratie persoonsgegevens (BRP) 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. http://fhir.nl/fhir/StructureDefinition/nl-core-address-official Constraints
|
|
| use | Σ ?! | 0..1 | codeBinding | Element Id
Address.use home | work | temp | old - purpose of this address DefinitionPurpose of this address Allows an appropriate address to be chosen from a list of many. 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.
General
home Mappings
|
| extension | 0..* | Extension | Element Id
Address.use.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
|
|
| AD_use | 0..1 | Extension(code) | Element Id
Address.use.extension:AD_use Further define the address use with the exact HCIM code. Alternate namesextensions, user content, Precieze definiëring van adressoort op basis van exacte zib-code DefinitionFurther define the address use with the exact HCIM code. Mostly relevant to distinguish between different types of temporary addresses. TMP and WP are not included in the valueset address-use but can be included through this extension Known issue (MM-1090): this HL7 FHIR core extension is incorrectly placed on Address.use. Instead it should be used on the root of the Address datatype. The next breaking release will fix this issue. More information can be found here: https://bits.nictiz.nl/browse/MM-1090 http://hl7.org/fhir/StructureDefinition/iso21090-AD-use Constraints
|
|
| url | 1..1 | uriFixed Value | Element Id
Address.use.extension:AD_use.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://hl7.org/fhir/StructureDefinition/iso21090-AD-use
|
|
| valueCode | 0..1 | codeBinding | Element Id
Address.use.extension:AD_use.valueCode:valueCode Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
|
| type | Σ | 0..1 | codeBinding | Element Id
Address.type postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. Note that FHIR strings may not exceed 1MB in size
General
both Mappings
|
| text | Σ | 0..1 | string | Element Id
Address.text Text representation of the address DefinitionA full text representation of the address. A renderable, unencoded form. Can provide both a text representation and parts.
General
137 Nowhere Street, Erewhon 9132 Mappings
|
| line | Σ | 0..* | string | Element Id
Address.line Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. home | work | temp | old - purpose of this address. Note that FHIR strings may not exceed 1MB in size
General
137 Nowhere Street Mappings
|
| extension | 0..* | Extension | Element Id
Address.line.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
|
|
| streetName | 0..1 | Extension(string) | Element Id
Address.line.extension:streetName streetName Alternate namesextensions, user content DefinitionStreet name. If the address is a P.O. Box then the Dutch word "Postbus" shall be communicated. If the address is an answer number (mailing address where the receiver pays postage) then the Dutch word "Antwoordnummer" shall be communicated. Basisregistratie Persoonsgegevens 11.10 Straatnaam 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName Constraints
|
|
| url | 1..1 | uriFixed Value | Element Id
Address.line.extension:streetName.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
|
|
| valueString | 0..1 | string | Element Id
Address.line.extension:streetName.valueString:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
|
| houseNumber | 0..1 | Extension(string) | Element Id
Address.line.extension:houseNumber houseNumber Alternate namesextensions, user content DefinitionThe element houseNumber shall contain the house number. The house number may contains non-numeric parts that further determine the address, e.g. "23a", but only if the source system cannot discretely communicate those. House letter shall, if possible, be communicated through the element buildingNumberSuffix. Information such as "to" (house boats that do not have their own house number, but are across (tegenover) a house with a house number or "3 hoog achter" are not part of this attribute. This type of information is conveyed elsewhere in the Address datatype. Basisregistratie Persoonsgegevens 11.20 Huisnummer 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber Constraints
|
|
| url | 1..1 | uriFixed Value | Element Id
Address.line.extension:houseNumber.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
|
|
| valueString | 0..1 | string | Element Id
Address.line.extension:houseNumber.valueString:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
|
| buildingNumbersuffix | 0..* | Extension(string) | Element Id
Address.line.extension:buildingNumbersuffix buildingNumberSuffix Alternate namesextensions, user content DefinitionHouseNumberLetter
HouseNumberAddition
Basisregistratie Persoonsgegevens 11.30 Huisletter 11.40 Huisnummertoevoeging 12.10 Locatieomschrijving Export
Import
http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix Constraints
|
|
| url | 1..1 | uriFixed Value | Element Id
Address.line.extension:buildingNumbersuffix.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
|
|
| valueString | 0..1 | string | Element Id
Address.line.extension:buildingNumbersuffix.valueString:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
|
| unitID | 0..1 | Extension(string) | Element Id
Address.line.extension:unitID unitID Alternate namesextensions, user content DefinitionExtra information such as the building name, building number, entrance, route number. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID Constraints
|
|
| url | 1..1 | uriFixed Value | Element Id
Address.line.extension:unitID.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
|
|
| valueString | 0..1 | string | Element Id
Address.line.extension:unitID.valueString:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
|
| additionalLocator | 0..1 | Extension(string) | Element Id
Address.line.extension:additionalLocator additionalLocator Alternate namesextensions, user content DefinitionHouseNumberIndication - The indication used for addresses that do not consist of the usual street name and house number. Basisregistratie Persoonsgegevens 11.50 Aanduiding bij huisnummer 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator Constraints
|
|
| url | 1..1 | uriFixed Value | Element Id
Address.line.extension:additionalLocator.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
|
|
| valueString | 0..1 | string | Element Id
Address.line.extension:additionalLocator.valueString:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
|
| city | Σ | 0..1 | string | Element Id
Address.city Name of city, town etc. Alternate namesMunicpality, Municipality, woonplaats DefinitionThe name of the city, town, village or other community or delivery center. Basisregistratie Persoonsgegevens 11.70 Woonplaatsnaam Note that FHIR strings may not exceed 1MB in size
General
Erewhon Example city
Den Haag Mappings
|
| district | Σ | 0..1 | string | Element Id
Address.district District name (aka county) Alternate namesCounty, Gemeente DefinitionThe name of the administrative area (county). Basisregistratie Persoonsgegevens 09.10 Gemeente van inschrijving 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. In a Dutch address this element is used for the population of a "gemeente"
General
Madison Example district
Wateringen Mappings
|
| state | Σ | 0..1 | string | Element Id
Address.state Sub-unit of country (abbreviations ok). Alternate namesProvince, Territory, Provincie DefinitionSub-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). For Dutch addresses this element should contain the "provincie" code Some (Dutch) cities have the same name in multiple provinces. Dutch examples include Bergen (Noord-Holland / Limburg) and Geesteren (Gelderland / Overijssel). Note that FHIR strings may not exceed 1MB in size
Example province
ZH Mappings
|
| postalCode | Σ | 0..1 | string | Element Id
Address.postalCode Postal code for area Alternate namesZip, Postcode DefinitionA postal code designating a region defined by the postal service. Dutch postal codes have pattern '\d{4}[A-Z]{2}' so they do not have spaces. Systems can easily render postal codes with a space if necessary.
General
9132 Example postcode
9132AG Mappings
|
| country | Σ | 0..1 | string | Element Id
Address.country Country (can be ISO 3166 3 letter code) Alternate namesland DefinitionA country (code) for the address. The FHIR datatype does not properly support coding the country using a CodeableConcept or Coding datatype. If the sender supports coded countries, it SHALL send the coded value using the code-specification extension under Address.country.
Example country
NLD Mappings
|
| extension | 0..* | Extension | Element Id
Address.country.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
|
|
| countryCode | 0..1 | Extension(CodeableConcept) | Element Id
Address.country.extension:countryCode CountryGBACode | CountryISOCode Alternate namesextensions, user content, Bevat de specifieke code conform de zib, bij een FHIR-element die een verplichte koppeling heeft met een bepaalde FHIR waardelijst of een FHIR element die niet gecodeerd is gedefinieerd, terwijl de zib dit wel doet. DefinitionDefines a more specific coded value for a code or string. Especially useful for FHIR's required ValueSets. These extensions are primarily used on codes bound to a required value set, where you would like to use a more specific code than the codes in the bounded value set. 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. http://nictiz.nl/fhir/StructureDefinition/code-specification Constraints
|
|
| url | 1..1 | uriFixed Value | Element Id
Address.country.extension:countryCode.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://nictiz.nl/fhir/StructureDefinition/code-specification
|
|
| valueCodeableConcept | 1..1 | CodeableConcept | Element Id
Address.country.extension:countryCode.valueCodeableConcept:valueCodeableConcept CountryGBACode | CountryISOCode Alternate namesLandGBACodelijst, LandISOCodelijst DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
|
| coding | Σ | 1..* | Coding | Element Id
Address.country.extension:countryCode.valueCodeableConcept:valueCodeableConcept.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Pattern) Constraints
|
| countryGBACodelist | Σ | 0..* | CodingBinding | Element Id
Address.country.extension:countryCode.valueCodeableConcept:valueCodeableConcept.coding:countryGBACodelist Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{
"system": "urn:oid:2.16.840.1.113883.2.4.4.16.34"
}
|
| countryISOCodelist | Σ | 0..* | CodingBinding | Element Id
Address.country.extension:countryCode.valueCodeableConcept:valueCodeableConcept.coding:countryISOCodelist Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{
"system": "urn:iso:std:iso:3166"
}
|
| text | Σ | 0..1 | string | Element Id
Address.country.extension:countryCode.value[x]:valueCodeableConcept.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| period | Σ | 0..1 | Period | Element Id
Address.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. 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.
General
{
"start": "2010-03-23",
"end": "2010-07-01"
}
Mappings
|
See the profile on simplifier.net for additional details.