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

Data Type Profile: nl-core-address

Official URL: http://fhir.nl/fhir/StructureDefinition/nl-core-address Version: 1.3.15
Active as of 2025-09-22 Computable Name: nl-core-address

Copyright/Legal: CC0

Base StructureDefinition for Address Type with additions for Dutch realm addresses. Dutch addresses break down Address.line in several parts and it is important to mark an address as being ‘officially registered’.

Address information is used for visiting a person or organization and for addressing of mail.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Address C 0..* Address Address information
Constraints: nl-streetname-if-official-and-other-line-parts
Example Example of a Vacation Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HV","display":"Vakantie adres"}]}}],"use":"temp","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 Example of a Primary Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HP","display":"Officieel adres"}]}},{"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"}
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:AddressType 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType
..... Slices for valueCodeableConcept Content/Rules for all slices
...... valueCodeableConcept:valueCodeableConcept 0..1 CodeableConcept AddressType
.... extension:official 0..1 boolean Mark an address as an 'officially registered' address.
URL: http://fhir.nl/fhir/StructureDefinition/nl-core-address-official
... use 0..1 code home | work | temp | old - purpose of this address
Binding: AddressUse (required)
... type 0..1 code postal | physical | both
Binding: AddressType (required)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:streetName 0..1 (Complex) streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
...... Slices for valueString Content/Rules for all slices
....... valueString:valueString 0..1 string Value of extension
..... extension:houseNumber 0..1 (Complex) houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
...... Slices for valueString Content/Rules for all slices
....... valueString:valueString 0..1 string Value of extension
..... extension:buildingNumbersuffix 0..* (Complex) buildingNumberSuffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
...... Slices for valueString Content/Rules for all slices
....... valueString:valueString 0..1 string Value of extension
..... extension:unitID 0..1 (Complex) unitID
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
...... Slices for valueString Content/Rules for all slices
....... valueString:valueString 0..1 string Value of extension
..... extension:additionalLocator 0..1 (Complex) additionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
...... Slices for valueString Content/Rules for all slices
....... valueString:valueString 0..1 string Value of extension
... city 0..1 string Name of city, town etc.
Example Example city: Den Haag
... district 0..1 string District name (aka county)
Example Example district: Wateringen
... state 0..1 string Sub-unit of country (abbreviations ok).
Example Example province: ZH
... postalCode C 0..1 string Postal code for area
Constraints: nl-postal-code-pattern
Example Example postcode: 9132AG
... country 0..1 string Country
Example Example country: NLD
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:countryCode 0..1 (Complex) CountryGBACode | CountryISOCode
URL: http://nictiz.nl/fhir/StructureDefinition/code-specification
...... Slices for valueCodeableConcept Content/Rules for all slices
....... valueCodeableConcept:valueCodeableConcept 1..1 CodeableConcept CountryGBACode | CountryISOCode
........ Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
......... coding:countryGBACodelist 0..* Coding Code defined by a terminology system
Binding: LandGBACodelijst (extensible): LandGBACodelijst
Required Pattern: At least the following
.......... system 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.16.34
......... coding:countryISOCodelist 0..* Coding Code defined by a terminology system
Binding: LandISOCodelijst (extensible): LandISOCodelijst
Required Pattern: At least the following
.......... system 1..1 uri Identity of the terminology system
Fixed Value: urn:iso:std:iso:3166

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
Address.userequiredAddressUse
Address.typerequiredAddressType
Address.country.extension:countryCode.valueCodeableConcept:valueCodeableConcept.coding:countryGBACodelistextensiblePattern Value: null
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.1--20171231000000
From this IG
Address.country.extension:countryCode.valueCodeableConcept:valueCodeableConcept.coding:countryISOCodelistextensiblePattern Value: null
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.2--20171231000000
From this IG

Constraints

IdGradePath(s)DetailsRequirements
nl-postal-code-patternerrorAddress.postalCodeDutch postal code pattern 'nnnnAA'
: (country in 'nl' | 'nld' | 'nederland').not() or matches('^\\d{4}[A-Z]{2}$')
nl-streetname-if-official-and-other-line-partserrorAddressAddress.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()))
This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Address C 0..* Address Address information
Constraints: nl-streetname-if-official-and-other-line-parts

Example Example of a Vacation Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HV","display":"Vakantie adres"}]}}],"use":"temp","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 Example of a Primary Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HP","display":"Officieel adres"}]}},{"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"}
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:AddressType 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType
..... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType"
..... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1 CodeableConcept AddressType
Binding: AdresSoortCodelijst (extensible): AdresSoortCodelijst
.... extension:official 0..1 boolean Mark an address as an 'officially registered' address.
URL: http://fhir.nl/fhir/StructureDefinition/nl-core-address-official
... use ?!Σ 0..1 code home | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example General: home
... type Σ 0..1 code postal | physical | both
Binding: AddressType (required)
Example General: both
... district Σ 0..1 string District name (aka county)
Example General: Madison
Example Example district: Wateringen
... state Σ 0..1 string Sub-unit of country (abbreviations ok).
Example Example province: ZH
... postalCode ΣC 0..1 string Postal code for area
Constraints: nl-postal-code-pattern
Example General: 9132
Example Example postcode: 9132AG
... country Σ 0..1 string Country
Example Example country: NLD
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:countryCode 0..1 (Complex) CountryGBACode | CountryISOCode
URL: http://nictiz.nl/fhir/StructureDefinition/code-specification
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/code-specification"
...... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 1..1 CodeableConcept CountryGBACode | CountryISOCode
........ Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
......... coding:countryGBACodelist Σ 0..* Coding Code defined by a terminology system
Binding: LandGBACodelijst (extensible): LandGBACodelijst

Required Pattern: At least the following
.......... id 0..1 string xml:id (or equivalent in JSON)
.......... extension 0..* Extension Additional Content defined by implementations
.......... system 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.16.34
.......... version 0..1 string Version of the system - if relevant
.......... code 0..1 code Symbol in syntax defined by the system
.......... display 0..1 string Representation defined by the system
.......... userSelected 0..1 boolean If this coding was chosen directly by the user
......... coding:countryISOCodelist Σ 0..* Coding Code defined by a terminology system
Binding: LandISOCodelijst (extensible): LandISOCodelijst

Required Pattern: At least the following
.......... id 0..1 string xml:id (or equivalent in JSON)
.......... extension 0..* Extension Additional Content defined by implementations
.......... system 1..1 uri Identity of the terminology system
Fixed Value: urn:iso:std:iso:3166
.......... version 0..1 string Version of the system - if relevant
.......... code 0..1 code Symbol in syntax defined by the system
.......... display 0..1 string Representation defined by the system
.......... userSelected 0..1 boolean If this coding was chosen directly by the user

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Address.extension:AddressType.value[x]:valueCodeableConceptextensibleAdresSoortCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.3--20171231000000
From this IG
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|3.0.2
From the FHIR Standard
Address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|3.0.2
From the FHIR Standard
Address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryGBACodelistextensiblePattern Value: null
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.1--20171231000000
From this IG
Address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryISOCodelistextensiblePattern Value: null
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.2--20171231000000
From this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nl-postal-code-patternerrorAddress.postalCodeDutch postal code pattern 'nnnnAA'
: (country in 'nl' | 'nld' | 'nederland').not() or matches('^\\d{4}[A-Z]{2}$')
nl-streetname-if-official-and-other-line-partserrorAddressAddress.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()))
This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Address C 0..* Address Address information
Constraints: nl-streetname-if-official-and-other-line-parts

Example Example of a Vacation Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HV","display":"Vakantie adres"}]}}],"use":"temp","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 Example of a Primary Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HP","display":"Officieel adres"}]}},{"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"}
... id 0..1 string xml:id (or equivalent in JSON)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:AddressType 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType"
..... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1 CodeableConcept AddressType
Binding: AdresSoortCodelijst (extensible): AdresSoortCodelijst
.... extension:official 0..1 boolean Mark an address as an 'officially registered' address.
URL: http://fhir.nl/fhir/StructureDefinition/nl-core-address-official
... use ?!Σ 0..1 code home | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example General: home
... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:streetName 0..1 (Complex) streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
...... Slices for valueString Content/Rules for all slices
....... valueString:valueString 0..1 string Value of extension
..... extension:houseNumber 0..1 (Complex) houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
...... Slices for valueString Content/Rules for all slices
....... valueString:valueString 0..1 string Value of extension
..... extension:buildingNumbersuffix 0..* (Complex) buildingNumberSuffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix"
...... Slices for valueString Content/Rules for all slices
....... valueString:valueString 0..1 string Value of extension
..... extension:unitID 0..1 (Complex) unitID
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID"
...... Slices for valueString Content/Rules for all slices
....... valueString:valueString 0..1 string Value of extension
..... extension:additionalLocator 0..1 (Complex) additionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator"
...... Slices for valueString Content/Rules for all slices
....... valueString:valueString 0..1 string Value of extension
.... value 0..1 string Primitive value for string
Max Length:1048576
... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
Example Example city: Den Haag
... district Σ 0..1 string District name (aka county)
Example General: Madison
Example Example district: Wateringen
... state Σ 0..1 string Sub-unit of country (abbreviations ok).
Example Example province: ZH
... postalCode ΣC 0..1 string Postal code for area
Constraints: nl-postal-code-pattern
Example General: 9132
Example Example postcode: 9132AG
... country Σ 0..1 string Country
Example Example country: NLD
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:countryCode 0..1 (Complex) CountryGBACode | CountryISOCode
URL: http://nictiz.nl/fhir/StructureDefinition/code-specification
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/code-specification"
...... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 1..1 CodeableConcept CountryGBACode | CountryISOCode
........ id 0..1 string xml:id (or equivalent in JSON)
........ extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
........ Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
......... coding:countryGBACodelist Σ 0..* Coding Code defined by a terminology system
Binding: LandGBACodelijst (extensible): LandGBACodelijst

Required Pattern: At least the following
.......... id 0..1 string xml:id (or equivalent in JSON)
.......... extension 0..* Extension Additional Content defined by implementations
.......... system 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.16.34
.......... version 0..1 string Version of the system - if relevant
.......... code 0..1 code Symbol in syntax defined by the system
.......... display 0..1 string Representation defined by the system
.......... userSelected 0..1 boolean If this coding was chosen directly by the user
......... coding:countryISOCodelist Σ 0..* Coding Code defined by a terminology system
Binding: LandISOCodelijst (extensible): LandISOCodelijst

Required Pattern: At least the following
.......... id 0..1 string xml:id (or equivalent in JSON)
.......... extension 0..* Extension Additional Content defined by implementations
.......... system 1..1 uri Identity of the terminology system
Fixed Value: urn:iso:std:iso:3166
.......... version 0..1 string Version of the system - if relevant
.......... code 0..1 code Symbol in syntax defined by the system
.......... display 0..1 string Representation defined by the system
.......... userSelected 0..1 boolean If this coding was chosen directly by the user
........ text Σ 0..1 string Plain text representation of the concept
.... value 0..1 string Primitive value for string
Max Length:1048576
... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Address.extension:AddressType.value[x]:valueCodeableConceptextensibleAdresSoortCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.3--20171231000000
From this IG
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|3.0.2
From the FHIR Standard
Address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|3.0.2
From the FHIR Standard
Address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryGBACodelistextensiblePattern Value: null
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.1--20171231000000
From this IG
Address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryISOCodelistextensiblePattern Value: null
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.2--20171231000000
From this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nl-postal-code-patternerrorAddress.postalCodeDutch postal code pattern 'nnnnAA'
: (country in 'nl' | 'nld' | 'nederland').not() or matches('^\\d{4}[A-Z]{2}$')
nl-streetname-if-official-and-other-line-partserrorAddressAddress.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()))
This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address

Differential View

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Address C 0..* Address Address information
Constraints: nl-streetname-if-official-and-other-line-parts
Example Example of a Vacation Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HV","display":"Vakantie adres"}]}}],"use":"temp","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 Example of a Primary Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HP","display":"Officieel adres"}]}},{"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"}
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:AddressType 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType
..... Slices for valueCodeableConcept Content/Rules for all slices
...... valueCodeableConcept:valueCodeableConcept 0..1 CodeableConcept AddressType
.... extension:official 0..1 boolean Mark an address as an 'officially registered' address.
URL: http://fhir.nl/fhir/StructureDefinition/nl-core-address-official
... use 0..1 code home | work | temp | old - purpose of this address
Binding: AddressUse (required)
... type 0..1 code postal | physical | both
Binding: AddressType (required)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:streetName 0..1 (Complex) streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
...... Slices for valueString Content/Rules for all slices
....... valueString:valueString 0..1 string Value of extension
..... extension:houseNumber 0..1 (Complex) houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
...... Slices for valueString Content/Rules for all slices
....... valueString:valueString 0..1 string Value of extension
..... extension:buildingNumbersuffix 0..* (Complex) buildingNumberSuffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
...... Slices for valueString Content/Rules for all slices
....... valueString:valueString 0..1 string Value of extension
..... extension:unitID 0..1 (Complex) unitID
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
...... Slices for valueString Content/Rules for all slices
....... valueString:valueString 0..1 string Value of extension
..... extension:additionalLocator 0..1 (Complex) additionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
...... Slices for valueString Content/Rules for all slices
....... valueString:valueString 0..1 string Value of extension
... city 0..1 string Name of city, town etc.
Example Example city: Den Haag
... district 0..1 string District name (aka county)
Example Example district: Wateringen
... state 0..1 string Sub-unit of country (abbreviations ok).
Example Example province: ZH
... postalCode C 0..1 string Postal code for area
Constraints: nl-postal-code-pattern
Example Example postcode: 9132AG
... country 0..1 string Country
Example Example country: NLD
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:countryCode 0..1 (Complex) CountryGBACode | CountryISOCode
URL: http://nictiz.nl/fhir/StructureDefinition/code-specification
...... Slices for valueCodeableConcept Content/Rules for all slices
....... valueCodeableConcept:valueCodeableConcept 1..1 CodeableConcept CountryGBACode | CountryISOCode
........ Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
......... coding:countryGBACodelist 0..* Coding Code defined by a terminology system
Binding: LandGBACodelijst (extensible): LandGBACodelijst
Required Pattern: At least the following
.......... system 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.16.34
......... coding:countryISOCodelist 0..* Coding Code defined by a terminology system
Binding: LandISOCodelijst (extensible): LandISOCodelijst
Required Pattern: At least the following
.......... system 1..1 uri Identity of the terminology system
Fixed Value: urn:iso:std:iso:3166

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
Address.userequiredAddressUse
Address.typerequiredAddressType
Address.country.extension:countryCode.valueCodeableConcept:valueCodeableConcept.coding:countryGBACodelistextensiblePattern Value: null
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.1--20171231000000
From this IG
Address.country.extension:countryCode.valueCodeableConcept:valueCodeableConcept.coding:countryISOCodelistextensiblePattern Value: null
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.2--20171231000000
From this IG

Constraints

IdGradePath(s)DetailsRequirements
nl-postal-code-patternerrorAddress.postalCodeDutch postal code pattern 'nnnnAA'
: (country in 'nl' | 'nld' | 'nederland').not() or matches('^\\d{4}[A-Z]{2}$')
nl-streetname-if-official-and-other-line-partserrorAddressAddress.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()))
This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Address C 0..* Address Address information
Constraints: nl-streetname-if-official-and-other-line-parts

Example Example of a Vacation Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HV","display":"Vakantie adres"}]}}],"use":"temp","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 Example of a Primary Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HP","display":"Officieel adres"}]}},{"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"}
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:AddressType 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType
..... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType"
..... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1 CodeableConcept AddressType
Binding: AdresSoortCodelijst (extensible): AdresSoortCodelijst
.... extension:official 0..1 boolean Mark an address as an 'officially registered' address.
URL: http://fhir.nl/fhir/StructureDefinition/nl-core-address-official
... use ?!Σ 0..1 code home | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example General: home
... type Σ 0..1 code postal | physical | both
Binding: AddressType (required)
Example General: both
... district Σ 0..1 string District name (aka county)
Example General: Madison
Example Example district: Wateringen
... state Σ 0..1 string Sub-unit of country (abbreviations ok).
Example Example province: ZH
... postalCode ΣC 0..1 string Postal code for area
Constraints: nl-postal-code-pattern
Example General: 9132
Example Example postcode: 9132AG
... country Σ 0..1 string Country
Example Example country: NLD
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:countryCode 0..1 (Complex) CountryGBACode | CountryISOCode
URL: http://nictiz.nl/fhir/StructureDefinition/code-specification
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/code-specification"
...... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 1..1 CodeableConcept CountryGBACode | CountryISOCode
........ Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
......... coding:countryGBACodelist Σ 0..* Coding Code defined by a terminology system
Binding: LandGBACodelijst (extensible): LandGBACodelijst

Required Pattern: At least the following
.......... id 0..1 string xml:id (or equivalent in JSON)
.......... extension 0..* Extension Additional Content defined by implementations
.......... system 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.16.34
.......... version 0..1 string Version of the system - if relevant
.......... code 0..1 code Symbol in syntax defined by the system
.......... display 0..1 string Representation defined by the system
.......... userSelected 0..1 boolean If this coding was chosen directly by the user
......... coding:countryISOCodelist Σ 0..* Coding Code defined by a terminology system
Binding: LandISOCodelijst (extensible): LandISOCodelijst

Required Pattern: At least the following
.......... id 0..1 string xml:id (or equivalent in JSON)
.......... extension 0..* Extension Additional Content defined by implementations
.......... system 1..1 uri Identity of the terminology system
Fixed Value: urn:iso:std:iso:3166
.......... version 0..1 string Version of the system - if relevant
.......... code 0..1 code Symbol in syntax defined by the system
.......... display 0..1 string Representation defined by the system
.......... userSelected 0..1 boolean If this coding was chosen directly by the user

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Address.extension:AddressType.value[x]:valueCodeableConceptextensibleAdresSoortCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.3--20171231000000
From this IG
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|3.0.2
From the FHIR Standard
Address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|3.0.2
From the FHIR Standard
Address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryGBACodelistextensiblePattern Value: null
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.1--20171231000000
From this IG
Address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryISOCodelistextensiblePattern Value: null
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.2--20171231000000
From this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nl-postal-code-patternerrorAddress.postalCodeDutch postal code pattern 'nnnnAA'
: (country in 'nl' | 'nld' | 'nederland').not() or matches('^\\d{4}[A-Z]{2}$')
nl-streetname-if-official-and-other-line-partserrorAddressAddress.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()))
This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Address C 0..* Address Address information
Constraints: nl-streetname-if-official-and-other-line-parts

Example Example of a Vacation Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HV","display":"Vakantie adres"}]}}],"use":"temp","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 Example of a Primary Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HP","display":"Officieel adres"}]}},{"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"}
... id 0..1 string xml:id (or equivalent in JSON)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:AddressType 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType"
..... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1 CodeableConcept AddressType
Binding: AdresSoortCodelijst (extensible): AdresSoortCodelijst
.... extension:official 0..1 boolean Mark an address as an 'officially registered' address.
URL: http://fhir.nl/fhir/StructureDefinition/nl-core-address-official
... use ?!Σ 0..1 code home | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example General: home
... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:streetName 0..1 (Complex) streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
...... Slices for valueString Content/Rules for all slices
....... valueString:valueString 0..1 string Value of extension
..... extension:houseNumber 0..1 (Complex) houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
...... Slices for valueString Content/Rules for all slices
....... valueString:valueString 0..1 string Value of extension
..... extension:buildingNumbersuffix 0..* (Complex) buildingNumberSuffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix"
...... Slices for valueString Content/Rules for all slices
....... valueString:valueString 0..1 string Value of extension
..... extension:unitID 0..1 (Complex) unitID
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID"
...... Slices for valueString Content/Rules for all slices
....... valueString:valueString 0..1 string Value of extension
..... extension:additionalLocator 0..1 (Complex) additionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator"
...... Slices for valueString Content/Rules for all slices
....... valueString:valueString 0..1 string Value of extension
.... value 0..1 string Primitive value for string
Max Length:1048576
... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
Example Example city: Den Haag
... district Σ 0..1 string District name (aka county)
Example General: Madison
Example Example district: Wateringen
... state Σ 0..1 string Sub-unit of country (abbreviations ok).
Example Example province: ZH
... postalCode ΣC 0..1 string Postal code for area
Constraints: nl-postal-code-pattern
Example General: 9132
Example Example postcode: 9132AG
... country Σ 0..1 string Country
Example Example country: NLD
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:countryCode 0..1 (Complex) CountryGBACode | CountryISOCode
URL: http://nictiz.nl/fhir/StructureDefinition/code-specification
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/code-specification"
...... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 1..1 CodeableConcept CountryGBACode | CountryISOCode
........ id 0..1 string xml:id (or equivalent in JSON)
........ extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
........ Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
......... coding:countryGBACodelist Σ 0..* Coding Code defined by a terminology system
Binding: LandGBACodelijst (extensible): LandGBACodelijst

Required Pattern: At least the following
.......... id 0..1 string xml:id (or equivalent in JSON)
.......... extension 0..* Extension Additional Content defined by implementations
.......... system 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.16.34
.......... version 0..1 string Version of the system - if relevant
.......... code 0..1 code Symbol in syntax defined by the system
.......... display 0..1 string Representation defined by the system
.......... userSelected 0..1 boolean If this coding was chosen directly by the user
......... coding:countryISOCodelist Σ 0..* Coding Code defined by a terminology system
Binding: LandISOCodelijst (extensible): LandISOCodelijst

Required Pattern: At least the following
.......... id 0..1 string xml:id (or equivalent in JSON)
.......... extension 0..* Extension Additional Content defined by implementations
.......... system 1..1 uri Identity of the terminology system
Fixed Value: urn:iso:std:iso:3166
.......... version 0..1 string Version of the system - if relevant
.......... code 0..1 code Symbol in syntax defined by the system
.......... display 0..1 string Representation defined by the system
.......... userSelected 0..1 boolean If this coding was chosen directly by the user
........ text Σ 0..1 string Plain text representation of the concept
.... value 0..1 string Primitive value for string
Max Length:1048576
... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Address.extension:AddressType.value[x]:valueCodeableConceptextensibleAdresSoortCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.3--20171231000000
From this IG
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|3.0.2
From the FHIR Standard
Address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|3.0.2
From the FHIR Standard
Address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryGBACodelistextensiblePattern Value: null
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.1--20171231000000
From this IG
Address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryISOCodelistextensiblePattern Value: null
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.2--20171231000000
From this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nl-postal-code-patternerrorAddress.postalCodeDutch postal code pattern 'nnnnAA'
: (country in 'nl' | 'nld' | 'nederland').not() or matches('^\\d{4}[A-Z]{2}$')
nl-streetname-if-official-and-other-line-partserrorAddressAddress.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()))
This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address

 

Other representations of profile: CSV, Excel, Schematron