This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 4.0.1. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://fhir.nl/fhir/StructureDefinition/nl-core-address
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'.
This profile was published on [no date] with unknown status '" by .
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Address.
Summary
Extensions
This structure refers to these extensions:
This structure is derived from Address.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | ∑ I | 0..* | Address | A physical/postal address nl-line-if-line-parts: Address.line SHALL have a value if one of streetName|houseNumber|buildingNumberSuffix|additionalLocator has a value nl-streetname-if-official-and-other-line-parts: Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value |
![]() ![]() ![]() | ∑ | 0..1 | string | Name of city, town etc. Example: Erewhon |
![]() ![]() ![]() | ∑ | 0..1 | string | District name (aka county) Example: Madison |
![]() ![]() ![]() | ∑ | 0..1 | string | Sub-unit of country (abbreviations ok) |
![]() ![]() ![]() | ∑ I | 0..1 | string | Postal code for area nl-postal-code-pattern: Dutch postal code pattern 'nnnnAA' Example: 9132 |
![]() ![]() ![]() | 0..1 | boolean | Mark an address as an 'officially registered' address. URL: http://fhir.nl/fhir/StructureDefinition/nl-address-official | |
![]() ![]() ![]() | 0..1 | string | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |
![]() ![]() ![]() | 0..1 | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |
![]() ![]() ![]() | 0..1 | string | buildingNumberSuffix URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix | |
![]() ![]() ![]() | 0..1 | string | additionalLocator URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | ∑ I | 0..* | Address | A physical/postal address nl-line-if-line-parts: Address.line SHALL have a value if one of streetName|houseNumber|buildingNumberSuffix|additionalLocator has a value nl-streetname-if-official-and-other-line-parts: Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value |
![]() ![]() ![]() | 0..1 | boolean | Extension URL: http://fhir.nl/fhir/StructureDefinition/nl-address-official | |
![]() ![]() ![]() | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |
![]() ![]() ![]() | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |
![]() ![]() ![]() | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix | |
![]() ![]() ![]() | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator | |
![]() ![]() ![]() | ?! ∑ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example: home |
![]() ![]() ![]() | ∑ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example: both |
![]() ![]() ![]() | ∑ | 0..1 | string | Text representation of the address Example: 137 Nowhere Street, Erewhon 9132 |
![]() ![]() ![]() | ∑ | 0..* | string | Street name, number, direction & P.O. Box etc. Example: 137 Nowhere Street |
![]() ![]() ![]() | ∑ | 0..1 | string | Name of city, town etc. Example: Erewhon |
![]() ![]() ![]() | ∑ | 0..1 | string | District name (aka county) Example: Madison |
![]() ![]() ![]() | ∑ | 0..1 | string | Sub-unit of country (abbreviations ok) |
![]() ![]() ![]() | ∑ I | 0..1 | string | Postal code for area nl-postal-code-pattern: Dutch postal code pattern 'nnnnAA' Example: 9132 |
![]() ![]() ![]() | ∑ | 0..1 | string | Country (can be ISO 3166 3 letter code) |
![]() ![]() ![]() | ∑ | 0..1 | Period | Time period when address was/is in use Example: {"start":"2010-03-23","end":"2010-07-01"} |
![]() |
todo
This structure is derived from Address.
Summary
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Address.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | ∑ I | 0..* | Address | A physical/postal address nl-line-if-line-parts: Address.line SHALL have a value if one of streetName|houseNumber|buildingNumberSuffix|additionalLocator has a value nl-streetname-if-official-and-other-line-parts: Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value |
![]() ![]() ![]() | ∑ | 0..1 | string | Name of city, town etc. Example: Erewhon |
![]() ![]() ![]() | ∑ | 0..1 | string | District name (aka county) Example: Madison |
![]() ![]() ![]() | ∑ | 0..1 | string | Sub-unit of country (abbreviations ok) |
![]() ![]() ![]() | ∑ I | 0..1 | string | Postal code for area nl-postal-code-pattern: Dutch postal code pattern 'nnnnAA' Example: 9132 |
![]() ![]() ![]() | 0..1 | boolean | Mark an address as an 'officially registered' address. URL: http://fhir.nl/fhir/StructureDefinition/nl-address-official | |
![]() ![]() ![]() | 0..1 | string | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |
![]() ![]() ![]() | 0..1 | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |
![]() ![]() ![]() | 0..1 | string | buildingNumberSuffix URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix | |
![]() ![]() ![]() | 0..1 | string | additionalLocator URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator | |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | ∑ I | 0..* | Address | A physical/postal address nl-line-if-line-parts: Address.line SHALL have a value if one of streetName|houseNumber|buildingNumberSuffix|additionalLocator has a value nl-streetname-if-official-and-other-line-parts: Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value |
![]() ![]() ![]() | 0..1 | boolean | Extension URL: http://fhir.nl/fhir/StructureDefinition/nl-address-official | |
![]() ![]() ![]() | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |
![]() ![]() ![]() | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |
![]() ![]() ![]() | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix | |
![]() ![]() ![]() | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator | |
![]() ![]() ![]() | ?! ∑ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example: home |
![]() ![]() ![]() | ∑ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example: both |
![]() ![]() ![]() | ∑ | 0..1 | string | Text representation of the address Example: 137 Nowhere Street, Erewhon 9132 |
![]() ![]() ![]() | ∑ | 0..* | string | Street name, number, direction & P.O. Box etc. Example: 137 Nowhere Street |
![]() ![]() ![]() | ∑ | 0..1 | string | Name of city, town etc. Example: Erewhon |
![]() ![]() ![]() | ∑ | 0..1 | string | District name (aka county) Example: Madison |
![]() ![]() ![]() | ∑ | 0..1 | string | Sub-unit of country (abbreviations ok) |
![]() ![]() ![]() | ∑ I | 0..1 | string | Postal code for area nl-postal-code-pattern: Dutch postal code pattern 'nnnnAA' Example: 9132 |
![]() ![]() ![]() | ∑ | 0..1 | string | Country (can be ISO 3166 3 letter code) |
![]() ![]() ![]() | ∑ | 0..1 | Period | Time period when address was/is in use Example: {"start":"2010-03-23","end":"2010-07-01"} |
![]() |
XML Template
JSON Template
todo
Other representations of profile: Schematron
Path | Name | Conformance | ValueSet |
Address.use | AddressUse | required | AddressUse |
Address.type | AddressType | required | AddressType |
Id | Path | Details | Requirements |
nl-line-if-line-parts | Address | Address.line SHALL have a value if one of streetName|houseNumber|buildingNumberSuffix|additionalLocator has a value XPath: not(f:extension[@url=('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName','http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber','http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix','http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator')]) or f:line | This constraint ensures compatibility with systems that do not support Dutch extensions |
nl-streetname-if-official-and-other-line-parts | Address | Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value XPath: not(f:extension[@url=('http://fhir.nl/fhir/StructureDefinition/nl-address-official')][f:valueBoolean/@value='true']) or not(f:extension[@url=('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber','http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix','http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator')]) or f:extension[@url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName'] | 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 |
nl-postal-code-pattern | Address.postalCode | Dutch postal code pattern 'nnnnAA' XPath: not(../f:country[lower-case(@value)=('nl','nld','nederland')]) or matches(@value,'^\d{4}[A-Z]{2}$') |