Nictiz FHIR NL STU3 Zib2017
1.3.15 - CI Build
Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Active as of 2024-04-09 |
Definitions for the nl-core-address data type profile.
Guidance on how to interpret the contents of this table can be found here
0. Address | |
Definition | There 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. |
Short | Address information |
Alternate Names | AdresInformatie |
Example | <br/><b>Example of a vacation home address</b>:{ "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" } <br/><b>Example of a primary home address</b>:{ "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" } |
Invariants | nl-streetname-if-official-and-other-line-parts: Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value ((extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not())) ) |
2. Address.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:official | |
Slice Name | official |
Definition | Mark an address as an 'officially registered' address. In Dutch context that means it is registered in the Basisregistratie persoonsgegevens (BRP) |
Short | Mark an address as an 'officially registered' address. |
Control | 0..1 |
Type | Extension(nl-core-address-official) (Extension Type: boolean) |
Alternate Names | Markeer een adres als een 'officieel geregistreerd adres. |
6. Address.use | |
Definition | Purpose of this address |
8. Address.use.extension | |
Slicing | This element introduces a set of slices on Address.use.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
10. Address.use.extension:AD_use | |
Slice Name | AD_use |
Definition | Further 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 |
Short | Further define the address use with the exact HCIM code. |
Comments | 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 |
Type | Extension(AD-use) (Extension Type: code) |
Alternate Names | Precieze definiëring van adressoort op basis van exacte zib-code |
12. Address.use.extension:AD_use.valueCode:valueCode | |
Slice Name | valueCode |
14. Address.type | |
16. Address.line | |
18. Address.line.extension | |
Slicing | This element introduces a set of slices on Address.line.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
20. Address.line.extension:streetName | |
Slice Name | streetName |
Definition | Street 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. |
Control | 0..1 |
Type | Extension(ADXP-streetName) (Extension Type: string) |
Requirements | Basisregistratie Persoonsgegevens 11.10 Straatnaam |
22. Address.line.extension:streetName.valueString:valueString | |
Slice Name | valueString |
24. Address.line.extension:houseNumber | |
Slice Name | houseNumber |
Definition | The 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. |
Control | 0..1 |
Type | Extension(ADXP-houseNumber) (Extension Type: string) |
Requirements | Basisregistratie Persoonsgegevens 11.20 Huisnummer |
26. Address.line.extension:houseNumber.valueString:valueString | |
Slice Name | valueString |
28. Address.line.extension:buildingNumbersuffix | |
Slice Name | buildingNumbersuffix |
Definition | HouseNumberLetter - A letter following the house number as assigned by the municipal authorities. HouseNumberAddition - The letters or signs needed to locate the mailbox, in addition to the house number and letter. |
Comments | Export
Import
|
Type | Extension(ADXP-buildingNumberSuffix) (Extension Type: string) |
Requirements | Basisregistratie Persoonsgegevens 11.30 Huisletter 11.40 Huisnummertoevoeging 12.10 Locatieomschrijving |
30. Address.line.extension:buildingNumbersuffix.valueString:valueString | |
Slice Name | valueString |
32. Address.line.extension:unitID | |
Slice Name | unitID |
Definition | Extra information such as the building name, building number, entrance, route number. |
Control | 0..1 |
Type | Extension(ADXP-unitID) (Extension Type: string) |
34. Address.line.extension:unitID.valueString:valueString | |
Slice Name | valueString |
36. Address.line.extension:additionalLocator | |
Slice Name | additionalLocator |
Definition | HouseNumberIndication - The indication used for addresses that do not consist of the usual street name and house number. |
Control | 0..1 |
Type | Extension(ADXP-additionalLocator) (Extension Type: string) |
Requirements | Basisregistratie Persoonsgegevens 11.50 Aanduiding bij huisnummer |
38. Address.line.extension:additionalLocator.valueString:valueString | |
Slice Name | valueString |
40. Address.city | |
Requirements | Basisregistratie Persoonsgegevens 11.70 Woonplaatsnaam |
Alternate Names | Municipality, woonplaats |
Example | <br/><b>Example city</b>:Den Haag |
42. Address.district | |
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. In a Dutch address this element is used for the population of a "gemeente" |
Requirements | Basisregistratie Persoonsgegevens 09.10 Gemeente van inschrijving |
Alternate Names | Gemeente |
Example | <br/><b>Example district</b>:Wateringen |
44. 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). For Dutch addresses this element should contain the "provincie" code |
Short | Sub-unit of country (abbreviations ok). |
Requirements | Some (Dutch) cities have the same name in multiple provinces. Dutch examples include Bergen (Noord-Holland / Limburg) and Geesteren (Gelderland / Overijssel). |
Alternate Names | Provincie |
Example | <br/><b>Example province</b>:ZH |
46. Address.postalCode | |
Comments | 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. |
Alternate Names | Postcode |
Example | <br/><b>Example postcode</b>:9132AG |
Invariants | nl-postal-code-pattern: Dutch postal code pattern 'nnnnAA' ((country in 'nl' | 'nld' | 'nederland').not() or matches('^\\d{4}[A-Z]{2}$') ) |
48. Address.country | |
Definition | A country (code) for the address. |
Short | Country (can be ISO 3166 3 letter code) |
Comments | 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. |
Alternate Names | land |
Example | <br/><b>Example country</b>:NLD |
50. Address.country.extension | |
Slicing | This element introduces a set of slices on Address.country.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
52. Address.country.extension:countryCode | |
Slice Name | countryCode |
Short | CountryGBACode | CountryISOCode |
Control | 0..1 |
Type | Extension(HCIM extension code-specification) (Extension Type: CodeableConcept) |
54. Address.country.extension:countryCode.valueCodeableConcept:valueCodeableConcept | |
Slice Name | valueCodeableConcept |
Short | CountryGBACode | CountryISOCode |
Alternate Names | LandGBACodelijst, LandISOCodelijst |
56. Address.country.extension:countryCode.valueCodeableConcept:valueCodeableConcept.coding | |
Control | 1..? |
Slicing | This element introduces a set of slices on Address.country.extension.valueCodeableConcept.coding . The slices are unordered and Open, and can be differentiated using the following discriminators: |
58. Address.country.extension:countryCode.valueCodeableConcept:valueCodeableConcept.coding:countryGBACodelist | |
Slice Name | countryGBACodelist |
Binding | Unless not suitable, these codes SHALL be taken from LandGBACodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.1--20171231000000 )LandGBACodelijst |
Pattern Value | { |
60. Address.country.extension:countryCode.valueCodeableConcept:valueCodeableConcept.coding:countryISOCodelist | |
Slice Name | countryISOCodelist |
Binding | Unless not suitable, these codes SHALL be taken from LandISOCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.2--20171231000000 )LandISOCodelijst |
Pattern Value | { |
Guidance on how to interpret the contents of this table can be found here
0. Address | |
Definition | There 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. 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. |
Short | Address informationAn address expressed using postal conventions (as opposed to GPS or other location definition formats) |
Comments | Note: address is for postal addresses, not physical locations. |
Control | 0..* This element is affected by the following invariants: ele-1, nl-streetname-if-official-and-other-line-parts |
Alternate Names | AdresInformatie |
Example | <br/><b>Example of a vacation home address</b>:{ "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" } <br/><b>Example of a primary home address</b>:{ "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" } |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )nl-streetname-if-official-and-other-line-parts: Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value ( (extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not())) )ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) |
2. Address.extension | |
Definition | An Extension 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. |
Short | ExtensionAdditional Content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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 | |
Slice Name | official |
Definition | Mark an address as an 'officially registered' address. In Dutch context that means it is registered in the Basisregistratie persoonsgegevens (BRP) |
Short | Mark an address as an 'officially registered' address. |
Control | 0..1 |
Type | Extension(nl-core-address-official) (Extension Type: boolean) |
Alternate Names | Markeer een adres als een 'officieel geregistreerd adres. |
6. Address.use | |
Definition | Purpose of this address The purpose of this address. |
Short | home | work | temp | old - purpose of this address |
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. |
Control | 0..1 |
Binding | The codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use (required to http://hl7.org/fhir/ValueSet/address-use )The use of an address |
Type | code |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows an appropriate address to be chosen from a list of many. |
Example | <br/><b>General</b>:home |
8. Address.use.extension | |
Definition | An Extension 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. |
Short | ExtensionAdditional Content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on Address.use.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
10. Address.use.extension:AD_use | |
Slice Name | AD_use |
Definition | Further 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 |
Short | Further define the address use with the exact HCIM code. |
Comments | 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 |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(AD-use) (Extension Type: code) |
Alternate Names | Precieze definiëring van adressoort op basis van exacte zib-code |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
12. Address.use.extension:AD_use.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
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. |
Control | 1..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-AD-use |
14. Address.use.extension:AD_use.valueCode:valueCode | |
Slice Name | valueCode |
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). |
Short | Value of extension |
Control | 0..1 |
Binding | The codes SHALL be taken from For codes, see PostalAddressUse (required to http://hl7.org/fhir/ValueSet/postal-address-use )Uses of an address not included in Address.use |
Type | code, date, dateTime, Meta, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
16. 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. |
Short | postal | physical | both |
Control | 0..1 |
Binding | The codes SHALL be taken from AddressTypehttp://hl7.org/fhir/ValueSet/address-type (required to http://hl7.org/fhir/ValueSet/address-type )The type of an address (physical / postal) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Example | <br/><b>General</b>:both |
18. Address.city | |
Definition | The name of the city, town, village or other community or delivery center. |
Short | Name of city, town etc. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Basisregistratie Persoonsgegevens 11.70 Woonplaatsnaam |
Alternate Names | Municpality, Municipality, woonplaats |
Example | <br/><b>General</b>:Erewhon <br/><b>Example city</b>:Den Haag |
20. Address.district | |
Definition | The name of the administrative area (county). |
Short | District name (aka 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. In a Dutch address this element is used for the population of a "gemeente" 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. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Basisregistratie Persoonsgegevens 09.10 Gemeente van inschrijving |
Alternate Names | County, Gemeente |
Example | <br/><b>General</b>:Madison <br/><b>Example district</b>:Wateringen |
22. 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). For Dutch addresses this element should contain the "provincie" code 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). |
Short | Sub-unit of country (abbreviations ok). |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Some (Dutch) cities have the same name in multiple provinces. Dutch examples include Bergen (Noord-Holland / Limburg) and Geesteren (Gelderland / Overijssel). |
Alternate Names | Province, Territory, Provincie |
Example | <br/><b>Example province</b>:ZH |
24. Address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Short | Postal code for area |
Comments | 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. |
Control | 0..1 This element is affected by the following invariants: nl-postal-code-pattern |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | Zip, Postcode |
Example | <br/><b>General</b>:9132 <br/><b>Example postcode</b>:9132AG |
Invariants | nl-postal-code-pattern: Dutch postal code pattern 'nnnnAA' ((country in 'nl' | 'nld' | 'nederland').not() or matches('^\\d{4}[A-Z]{2}$') ) |
26. Address.country | |
Definition | A country (code) for the address. Country - a nation as commonly understood or generally accepted. |
Short | Country (can be ISO 3166 3 letter code)Country (e.g. can be ISO 3166 2 or 3 letter code) |
Comments | 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. ISO 3166 3 letter codes can be used in place of a full country name. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | land |
Example | <br/><b>Example country</b>:NLD |
28. Address.country.extension | |
Definition | An Extension 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. |
Short | ExtensionAdditional Content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on Address.country.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
30. Address.country.extension:countryCode | |
Slice Name | countryCode |
Definition | Defines 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. |
Short | CountryGBACode | CountryISOCode |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(HCIM extension code-specification) (Extension Type: CodeableConcept) |
Alternate Names | 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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
32. Address.country.extension:countryCode.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
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. |
Control | 1..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | http://nictiz.nl/fhir/StructureDefinition/code-specification |
34. Address.country.extension:countryCode.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). |
Short | Value of extension |
Control | 10..1 |
Type | CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal |
[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.country.extension.value[x] . The slices are unordered and Closed, and can be differentiated using the following discriminators: |
36. Address.country.extension:countryCode.value[x]:valueCodeableConcept | |
Slice Name | 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). |
Short | CountryGBACode | CountryISOCodeValue of extension |
Control | 10..1 |
Type | CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Alternate Names | LandGBACodelijst, LandISOCodelijst |
38. Address.country.extension:countryCode.value[x]:valueCodeableConcept.coding | |
Definition | A reference to a code defined by a terminology system. |
Short | Code defined by a terminology system |
Comments | 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. |
Control | 10..* |
Type | Coding |
Summary | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Slicing | This element introduces a set of slices on Address.country.extension.value[x].coding . The slices are unordered and Open, and can be differentiated using the following discriminators: |
40. Address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryGBACodelist | |
Slice Name | countryGBACodelist |
Definition | A reference to a code defined by a terminology system. |
Short | Code defined by a terminology system |
Comments | 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. |
Control | 0..* |
Binding | Unless not suitable, these codes SHALL be taken from For codes, see LandGBACodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.1--20171231000000 )LandGBACodelijst |
Type | Coding |
Summary | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Pattern Value | { |
42. Address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryISOCodelist | |
Slice Name | countryISOCodelist |
Definition | A reference to a code defined by a terminology system. |
Short | Code defined by a terminology system |
Comments | 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. |
Control | 0..* |
Binding | Unless not suitable, these codes SHALL be taken from For codes, see LandISOCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.2--20171231000000 )LandISOCodelijst |
Type | Coding |
Summary | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Pattern Value | { |
Guidance on how to interpret the contents of this table can be found here
0. Address | |
Definition | There 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. |
Short | Address information |
Comments | Note: address is for postal addresses, not physical locations. |
Control | 0..* This element is affected by the following invariants: ele-1, nl-streetname-if-official-and-other-line-parts |
Alternate Names | AdresInformatie |
Example | <br/><b>Example of a vacation home address</b>:{ "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" } <br/><b>Example of a primary home address</b>:{ "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" } |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )nl-streetname-if-official-and-other-line-parts: Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value ( (extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not())) ) |
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. |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
4. Address.extension | |
Definition | An Extension |
Short | 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: |
6. Address.extension:official | |
Slice Name | official |
Definition | Mark an address as an 'officially registered' address. In Dutch context that means it is registered in the Basisregistratie persoonsgegevens (BRP) |
Short | Mark an address as an 'officially registered' address. |
Control | 0..1 |
Type | Extension(nl-core-address-official) (Extension Type: boolean) |
Alternate Names | Markeer een adres als een 'officieel geregistreerd adres. |
8. Address.use | |
Definition | Purpose of this address |
Short | home | work | temp | old - purpose of this address |
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. |
Control | 0..1 |
Binding | The codes SHALL be taken from AddressUse (required to http://hl7.org/fhir/ValueSet/address-use )The use of an address |
Type | code |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows an appropriate address to be chosen from a list of many. |
Example | <br/><b>General</b>:home |
10. Address.use.id | |
Definition | unique id for the element within a resource (for internal references) |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
12. Address.use.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..* |
Type | Extension |
Slicing | This element introduces a set of slices on Address.use.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
14. Address.use.extension:AD_use | |
Slice Name | AD_use |
Definition | Further 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 |
Short | Further define the address use with the exact HCIM code. |
Comments | 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 |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(AD-use) (Extension Type: code) |
Alternate Names | Precieze definiëring van adressoort op basis van exacte zib-code |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
16. Address.use.extension:AD_use.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
18. Address.use.extension:AD_use.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. |
Short | Additional Content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on Address.use.extension.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
20. Address.use.extension:AD_use.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
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. |
Control | 1..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-AD-use |
22. Address.use.extension:AD_use.valueCode:valueCode | |
Slice Name | valueCode |
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). |
Short | Value of extension |
Control | 0..1 |
Binding | The codes SHALL be taken from PostalAddressUse (required to http://hl7.org/fhir/ValueSet/postal-address-use )Uses of an address not included in Address.use |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
24. Address.use.value | |
Definition | Primitive value for code |
Short | Primitive value for code |
Control | 0..1 |
Type | code |
XML Format | In the XML format, this property is represented as an attribute. |
26. 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. |
Short | postal | physical | both |
Control | 0..1 |
Binding | The codes SHALL be taken from AddressType (required to http://hl7.org/fhir/ValueSet/address-type )The type of an address (physical / postal) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Example | <br/><b>General</b>:both |
28. Address.text | |
Definition | A full text representation of the address. |
Short | Text representation of the address |
Comments | Can provide both a text representation and parts. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | A renderable, unencoded form. |
Example | <br/><b>General</b>:137 Nowhere Street, Erewhon 9132 |
30. 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. |
Short | Street name, number, direction & P.O. Box etc. |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | home | work | temp | old - purpose of this address. |
Example | <br/><b>General</b>:137 Nowhere Street |
32. Address.line.id | |
Definition | unique id for the element within a resource (for internal references) |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
34. Address.line.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..* |
Type | Extension |
Slicing | This element introduces a set of slices on Address.line.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
36. Address.line.extension:streetName | |
Slice Name | streetName |
Definition | Street 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. |
Short | streetName |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ADXP-streetName) (Extension Type: string) |
Requirements | Basisregistratie Persoonsgegevens 11.10 Straatnaam |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
38. Address.line.extension:streetName.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
40. Address.line.extension:streetName.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. |
Short | Additional Content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on Address.line.extension.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
42. Address.line.extension:streetName.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
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. |
Control | 1..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName |
44. Address.line.extension:streetName.valueString:valueString | |
Slice Name | 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). |
Short | Value of extension |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
46. Address.line.extension:houseNumber | |
Slice Name | houseNumber |
Definition | The 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. |
Short | houseNumber |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ADXP-houseNumber) (Extension Type: string) |
Requirements | Basisregistratie Persoonsgegevens 11.20 Huisnummer |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
48. Address.line.extension:houseNumber.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
50. Address.line.extension:houseNumber.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. |
Short | Additional Content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on Address.line.extension.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
52. Address.line.extension:houseNumber.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
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. |
Control | 1..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber |
54. Address.line.extension:houseNumber.valueString:valueString | |
Slice Name | 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). |
Short | Value of extension |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
56. Address.line.extension:buildingNumbersuffix | |
Slice Name | buildingNumbersuffix |
Definition | HouseNumberLetter - A letter following the house number as assigned by the municipal authorities. HouseNumberAddition - The letters or signs needed to locate the mailbox, in addition to the house number and letter. |
Short | buildingNumberSuffix |
Comments | Export
Import
|
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(ADXP-buildingNumberSuffix) (Extension Type: string) |
Requirements | Basisregistratie Persoonsgegevens 11.30 Huisletter 11.40 Huisnummertoevoeging 12.10 Locatieomschrijving |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
58. Address.line.extension:buildingNumbersuffix.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
60. Address.line.extension:buildingNumbersuffix.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. |
Short | Additional Content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on Address.line.extension.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
62. Address.line.extension:buildingNumbersuffix.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
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. |
Control | 1..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix |
64. Address.line.extension:buildingNumbersuffix.valueString:valueString | |
Slice Name | 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). |
Short | Value of extension |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
66. Address.line.extension:unitID | |
Slice Name | unitID |
Definition | Extra information such as the building name, building number, entrance, route number. |
Short | unitID |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ADXP-unitID) (Extension Type: string) |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
68. Address.line.extension:unitID.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
70. Address.line.extension:unitID.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. |
Short | Additional Content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on Address.line.extension.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
72. Address.line.extension:unitID.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
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. |
Control | 1..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID |
74. Address.line.extension:unitID.valueString:valueString | |
Slice Name | 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). |
Short | Value of extension |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
76. Address.line.extension:additionalLocator | |
Slice Name | additionalLocator |
Definition | HouseNumberIndication - The indication used for addresses that do not consist of the usual street name and house number. |
Short | additionalLocator |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ADXP-additionalLocator) (Extension Type: string) |
Requirements | Basisregistratie Persoonsgegevens 11.50 Aanduiding bij huisnummer |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
78. Address.line.extension:additionalLocator.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
80. Address.line.extension:additionalLocator.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. |
Short | Additional Content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on Address.line.extension.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
82. Address.line.extension:additionalLocator.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
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. |
Control | 1..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator |
84. Address.line.extension:additionalLocator.valueString:valueString | |
Slice Name | 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). |
Short | Value of extension |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
86. Address.line.value | |
Definition | The actual value |
Short | Primitive value for string |
Control | 0..1 |
Type | string |
XML Format | In the XML format, this property is represented as an attribute. |
Max Length | 1048576 |
88. Address.city | |
Definition | The name of the city, town, village or other community or delivery center. |
Short | Name of city, town etc. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Basisregistratie Persoonsgegevens 11.70 Woonplaatsnaam |
Alternate Names | Municpality, Municipality, woonplaats |
Example | <br/><b>General</b>:Erewhon <br/><b>Example city</b>:Den Haag |
90. Address.district | |
Definition | The name of the administrative area (county). |
Short | District name (aka 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. In a Dutch address this element is used for the population of a "gemeente" |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Basisregistratie Persoonsgegevens 09.10 Gemeente van inschrijving |
Alternate Names | County, Gemeente |
Example | <br/><b>General</b>:Madison <br/><b>Example district</b>:Wateringen |
92. 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). For Dutch addresses this element should contain the "provincie" code |
Short | Sub-unit of country (abbreviations ok). |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Some (Dutch) cities have the same name in multiple provinces. Dutch examples include Bergen (Noord-Holland / Limburg) and Geesteren (Gelderland / Overijssel). |
Alternate Names | Province, Territory, Provincie |
Example | <br/><b>Example province</b>:ZH |
94. Address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Short | Postal code for area |
Comments | 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. |
Control | 0..1 This element is affected by the following invariants: nl-postal-code-pattern |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | Zip, Postcode |
Example | <br/><b>General</b>:9132 <br/><b>Example postcode</b>:9132AG |
Invariants | nl-postal-code-pattern: Dutch postal code pattern 'nnnnAA' ((country in 'nl' | 'nld' | 'nederland').not() or matches('^\\d{4}[A-Z]{2}$') ) |
96. Address.country | |
Definition | A country (code) for the address. |
Short | Country (can be ISO 3166 3 letter code) |
Comments | 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. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | land |
Example | <br/><b>Example country</b>:NLD |
98. Address.country.id | |
Definition | unique id for the element within a resource (for internal references) |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
100. Address.country.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..* |
Type | Extension |
Slicing | This element introduces a set of slices on Address.country.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
102. Address.country.extension:countryCode | |
Slice Name | countryCode |
Definition | Defines 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. |
Short | CountryGBACode | CountryISOCode |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(HCIM extension code-specification) (Extension Type: CodeableConcept) |
Alternate Names | 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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
104. Address.country.extension:countryCode.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
106. Address.country.extension:countryCode.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. |
Short | Additional Content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on Address.country.extension.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
108. Address.country.extension:countryCode.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
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. |
Control | 1..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | http://nictiz.nl/fhir/StructureDefinition/code-specification |
110. Address.country.extension:countryCode.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). |
Short | Value of extension |
Control | 1..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.country.extension.value[x] . The slices are unordered and Closed, and can be differentiated using the following discriminators: |
112. Address.country.extension:countryCode.value[x]:valueCodeableConcept | |
Slice Name | 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). |
Short | CountryGBACode | CountryISOCode |
Control | 1..1 |
Type | CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Alternate Names | LandGBACodelijst, LandISOCodelijst |
114. Address.country.extension:countryCode.value[x]:valueCodeableConcept.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
116. Address.country.extension:countryCode.value[x]:valueCodeableConcept.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. |
Short | Additional Content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on Address.country.extension.value[x].extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
118. Address.country.extension:countryCode.value[x]:valueCodeableConcept.coding | |
Definition | A reference to a code defined by a terminology system. |
Short | Code defined by a terminology system |
Comments | 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. |
Control | 1..* |
Type | Coding |
Summary | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Slicing | This element introduces a set of slices on Address.country.extension.value[x].coding . The slices are unordered and Open, and can be differentiated using the following discriminators: |
120. Address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryGBACodelist | |
Slice Name | countryGBACodelist |
Definition | A reference to a code defined by a terminology system. |
Short | Code defined by a terminology system |
Comments | 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. |
Control | 0..* |
Binding | Unless not suitable, these codes SHALL be taken from LandGBACodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.1--20171231000000 )LandGBACodelijst |
Type | Coding |
Summary | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Pattern Value | { |
122. Address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryISOCodelist | |
Slice Name | countryISOCodelist |
Definition | A reference to a code defined by a terminology system. |
Short | Code defined by a terminology system |
Comments | 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. |
Control | 0..* |
Binding | Unless not suitable, these codes SHALL be taken from LandISOCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.2--20171231000000 )LandISOCodelijst |
Type | Coding |
Summary | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Pattern Value | { |
124. Address.country.extension:countryCode.value[x]:valueCodeableConcept.text | |
Definition | A 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. |
Short | Plain text representation of the concept |
Comments | Very often the text is the same as a displayName of one of the codings. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | 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. |
126. Address.country.value | |
Definition | The actual value |
Short | Primitive value for string |
Control | 0..1 |
Type | string |
XML Format | In the XML format, this property is represented as an attribute. |
Max Length | 1048576 |
128. Address.period | |
Definition | Time period when address was/is in use. |
Short | Time period when address was/is in use |
Control | 0..1 |
Type | Period |
Summary | true |
Requirements | Allows addresses to be placed in historical context. |
Example | <br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" } |