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
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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Address
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
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"} |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | AddressType | |
![]() ![]() ![]() ![]() |
0..1 | boolean | Mark an address as an 'officially registered' address. URL: http://fhir.nl/fhir/StructureDefinition/nl-core-address-official | |
![]() ![]() ![]() |
0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) | |
![]() ![]() ![]() |
0..1 | code | postal | physical | both Binding: AddressType (required) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
0..* | (Complex) | buildingNumberSuffix URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | unitID URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | additionalLocator URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() |
0..1 | string | Name of city, town etc. Example Example city: Den Haag | |
![]() ![]() ![]() |
0..1 | string | District name (aka county) Example Example district: Wateringen | |
![]() ![]() ![]() |
0..1 | string | Sub-unit of country (abbreviations ok). Example Example province: ZH | |
![]() ![]() ![]() |
C | 0..1 | string | Postal code for area Constraints: nl-postal-code-pattern Example Example postcode: 9132AG |
![]() ![]() ![]() |
0..1 | string | Country Example Example country: NLD | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | CountryGBACode | CountryISOCode URL: http://nictiz.nl/fhir/StructureDefinition/code-specification | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | CountryGBACode | CountryISOCode | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Binding: LandGBACodelijst (extensible): LandGBACodelijst Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.16.34 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Binding: LandISOCodelijst (extensible): LandISOCodelijst Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 | |
![]() |
Path | Conformance | ValueSet / Code | URI |
Address.use | required | AddressUse | |
Address.type | required | AddressType | |
Address.country.extension:countryCode.valueCodeableConcept:valueCodeableConcept.coding:countryGBACodelist | extensible | Pattern Value: nullhttp://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:countryISOCodelist | extensible | Pattern Value: nullhttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.2--20171231000000 From this IG |
Id | Grade | Path(s) | Details | Requirements |
nl-postal-code-pattern | error | Address.postalCode | Dutch postal code pattern 'nnnnAA' : (country in 'nl' | 'nld' | 'nederland').not() or matches('^\\d{4}[A-Z]{2}$') | |
nl-streetname-if-official-and-other-line-parts | error | Address | 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())) | 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 |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
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"} |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | AddressType Binding: AdresSoortCodelijst (extensible): AdresSoortCodelijst | |
![]() ![]() ![]() ![]() |
0..1 | boolean | Mark an address as an 'officially registered' address. URL: http://fhir.nl/fhir/StructureDefinition/nl-core-address-official | |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example General: home |
![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General: both |
![]() ![]() ![]() |
Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example Example city: Den Haag |
![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison Example Example district: Wateringen |
![]() ![]() ![]() |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok). Example Example province: ZH |
![]() ![]() ![]() |
ΣC | 0..1 | string | Postal code for area Constraints: nl-postal-code-pattern Example General: 9132 Example Example postcode: 9132AG |
![]() ![]() ![]() |
Σ | 0..1 | string | Country Example Example country: NLD |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | CountryGBACode | CountryISOCode URL: http://nictiz.nl/fhir/StructureDefinition/code-specification | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/code-specification" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | CountryGBACode | CountryISOCode | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Binding: LandGBACodelijst (extensible): LandGBACodelijst Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.16.34 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Binding: LandISOCodelijst (extensible): LandISOCodelijst Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() |
Path | Conformance | ValueSet / Code | URI |
Address.extension:AddressType.value[x]:valueCodeableConcept | extensible | AdresSoortCodelijsthttp://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.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|3.0.2 From the FHIR Standard | |
Address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|3.0.2 From the FHIR Standard | |
Address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryGBACodelist | extensible | Pattern Value: nullhttp://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:countryISOCodelist | extensible | Pattern Value: nullhttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.2--20171231000000 From this IG |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
nl-postal-code-pattern | error | Address.postalCode | Dutch postal code pattern 'nnnnAA' : (country in 'nl' | 'nld' | 'nederland').not() or matches('^\\d{4}[A-Z]{2}$') | |
nl-streetname-if-official-and-other-line-parts | error | Address | 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())) | 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 |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
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"} |
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | AddressType Binding: AdresSoortCodelijst (extensible): AdresSoortCodelijst | |
![]() ![]() ![]() ![]() |
0..1 | boolean | Mark an address as an 'officially registered' address. URL: http://fhir.nl/fhir/StructureDefinition/nl-core-address-official | |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example General: home |
![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General: both |
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName" | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber" | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
0..* | (Complex) | buildingNumberSuffix URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix" | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | unitID URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID" | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | additionalLocator URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator" | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |
![]() ![]() ![]() |
Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example Example city: Den Haag |
![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison Example Example district: Wateringen |
![]() ![]() ![]() |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok). Example Example province: ZH |
![]() ![]() ![]() |
ΣC | 0..1 | string | Postal code for area Constraints: nl-postal-code-pattern Example General: 9132 Example Example postcode: 9132AG |
![]() ![]() ![]() |
Σ | 0..1 | string | Country Example Example country: NLD |
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | CountryGBACode | CountryISOCode URL: http://nictiz.nl/fhir/StructureDefinition/code-specification | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/code-specification" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | CountryGBACode | CountryISOCode | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Binding: LandGBACodelijst (extensible): LandGBACodelijst Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.16.34 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Binding: LandISOCodelijst (extensible): LandISOCodelijst Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
![]() |
Path | Conformance | ValueSet / Code | URI |
Address.extension:AddressType.value[x]:valueCodeableConcept | extensible | AdresSoortCodelijsthttp://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.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|3.0.2 From the FHIR Standard | |
Address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|3.0.2 From the FHIR Standard | |
Address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryGBACodelist | extensible | Pattern Value: nullhttp://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:countryISOCodelist | extensible | Pattern Value: nullhttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.2--20171231000000 From this IG |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
nl-postal-code-pattern | error | Address.postalCode | Dutch postal code pattern 'nnnnAA' : (country in 'nl' | 'nld' | 'nederland').not() or matches('^\\d{4}[A-Z]{2}$') | |
nl-streetname-if-official-and-other-line-parts | error | Address | 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())) | 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 |
This structure is derived from Address
Summary
Mandatory: 0 element(1 nested mandatory element)
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Address
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
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"} |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | AddressType | |
![]() ![]() ![]() ![]() |
0..1 | boolean | Mark an address as an 'officially registered' address. URL: http://fhir.nl/fhir/StructureDefinition/nl-core-address-official | |
![]() ![]() ![]() |
0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) | |
![]() ![]() ![]() |
0..1 | code | postal | physical | both Binding: AddressType (required) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
0..* | (Complex) | buildingNumberSuffix URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | unitID URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | additionalLocator URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() |
0..1 | string | Name of city, town etc. Example Example city: Den Haag | |
![]() ![]() ![]() |
0..1 | string | District name (aka county) Example Example district: Wateringen | |
![]() ![]() ![]() |
0..1 | string | Sub-unit of country (abbreviations ok). Example Example province: ZH | |
![]() ![]() ![]() |
C | 0..1 | string | Postal code for area Constraints: nl-postal-code-pattern Example Example postcode: 9132AG |
![]() ![]() ![]() |
0..1 | string | Country Example Example country: NLD | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | CountryGBACode | CountryISOCode URL: http://nictiz.nl/fhir/StructureDefinition/code-specification | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | CountryGBACode | CountryISOCode | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Binding: LandGBACodelijst (extensible): LandGBACodelijst Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.16.34 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Binding: LandISOCodelijst (extensible): LandISOCodelijst Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 | |
![]() |
Path | Conformance | ValueSet / Code | URI |
Address.use | required | AddressUse | |
Address.type | required | AddressType | |
Address.country.extension:countryCode.valueCodeableConcept:valueCodeableConcept.coding:countryGBACodelist | extensible | Pattern Value: nullhttp://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:countryISOCodelist | extensible | Pattern Value: nullhttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.2--20171231000000 From this IG |
Id | Grade | Path(s) | Details | Requirements |
nl-postal-code-pattern | error | Address.postalCode | Dutch postal code pattern 'nnnnAA' : (country in 'nl' | 'nld' | 'nederland').not() or matches('^\\d{4}[A-Z]{2}$') | |
nl-streetname-if-official-and-other-line-parts | error | Address | 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())) | 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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
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"} |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | AddressType Binding: AdresSoortCodelijst (extensible): AdresSoortCodelijst | |
![]() ![]() ![]() ![]() |
0..1 | boolean | Mark an address as an 'officially registered' address. URL: http://fhir.nl/fhir/StructureDefinition/nl-core-address-official | |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example General: home |
![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General: both |
![]() ![]() ![]() |
Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example Example city: Den Haag |
![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison Example Example district: Wateringen |
![]() ![]() ![]() |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok). Example Example province: ZH |
![]() ![]() ![]() |
ΣC | 0..1 | string | Postal code for area Constraints: nl-postal-code-pattern Example General: 9132 Example Example postcode: 9132AG |
![]() ![]() ![]() |
Σ | 0..1 | string | Country Example Example country: NLD |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | CountryGBACode | CountryISOCode URL: http://nictiz.nl/fhir/StructureDefinition/code-specification | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/code-specification" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | CountryGBACode | CountryISOCode | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Binding: LandGBACodelijst (extensible): LandGBACodelijst Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.16.34 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Binding: LandISOCodelijst (extensible): LandISOCodelijst Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() |
Path | Conformance | ValueSet / Code | URI |
Address.extension:AddressType.value[x]:valueCodeableConcept | extensible | AdresSoortCodelijsthttp://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.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|3.0.2 From the FHIR Standard | |
Address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|3.0.2 From the FHIR Standard | |
Address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryGBACodelist | extensible | Pattern Value: nullhttp://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:countryISOCodelist | extensible | Pattern Value: nullhttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.2--20171231000000 From this IG |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
nl-postal-code-pattern | error | Address.postalCode | Dutch postal code pattern 'nnnnAA' : (country in 'nl' | 'nld' | 'nederland').not() or matches('^\\d{4}[A-Z]{2}$') | |
nl-streetname-if-official-and-other-line-parts | error | Address | 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())) | 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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
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"} |
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | AddressType Binding: AdresSoortCodelijst (extensible): AdresSoortCodelijst | |
![]() ![]() ![]() ![]() |
0..1 | boolean | Mark an address as an 'officially registered' address. URL: http://fhir.nl/fhir/StructureDefinition/nl-core-address-official | |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example General: home |
![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General: both |
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName" | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber" | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
0..* | (Complex) | buildingNumberSuffix URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix" | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | unitID URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID" | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | additionalLocator URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator" | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |
![]() ![]() ![]() |
Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example Example city: Den Haag |
![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison Example Example district: Wateringen |
![]() ![]() ![]() |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok). Example Example province: ZH |
![]() ![]() ![]() |
ΣC | 0..1 | string | Postal code for area Constraints: nl-postal-code-pattern Example General: 9132 Example Example postcode: 9132AG |
![]() ![]() ![]() |
Σ | 0..1 | string | Country Example Example country: NLD |
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | CountryGBACode | CountryISOCode URL: http://nictiz.nl/fhir/StructureDefinition/code-specification | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/code-specification" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | CountryGBACode | CountryISOCode | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Binding: LandGBACodelijst (extensible): LandGBACodelijst Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.16.34 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Binding: LandISOCodelijst (extensible): LandISOCodelijst Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
![]() |
Path | Conformance | ValueSet / Code | URI |
Address.extension:AddressType.value[x]:valueCodeableConcept | extensible | AdresSoortCodelijsthttp://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.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|3.0.2 From the FHIR Standard | |
Address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|3.0.2 From the FHIR Standard | |
Address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryGBACodelist | extensible | Pattern Value: nullhttp://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:countryISOCodelist | extensible | Pattern Value: nullhttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.5.2--20171231000000 From this IG |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
nl-postal-code-pattern | error | Address.postalCode | Dutch postal code pattern 'nnnnAA' : (country in 'nl' | 'nld' | 'nederland').not() or matches('^\\d{4}[A-Z]{2}$') | |
nl-streetname-if-official-and-other-line-parts | error | Address | 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())) | 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 |
This structure is derived from Address
Summary
Mandatory: 0 element(1 nested mandatory element)
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron