Connectathon 11 Snapshot

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

L.?? StructureDefinition: nl-core-address

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 .

L.??.1 Formal Views of Profile Content

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

This structure is derived from Address.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*AddressA 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
... city 0..1stringName of city, town etc.
Example: Erewhon
... district 0..1stringDistrict name (aka county)
Example: Madison
... state 0..1stringSub-unit of country (abbreviations ok)
... postalCode I0..1stringPostal code for area
nl-postal-code-pattern: Dutch postal code pattern 'nnnnAA'
Example: 9132
... nl-address-official 0..1booleanMark an address as an 'officially registered' address.
URL: http://fhir.nl/fhir/StructureDefinition/nl-address-official
... iso21090-ADXP-streetName 0..1stringstreetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
... iso21090-ADXP-houseNumber 0..1stringhouseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
... iso21090-ADXP-buildingNumberSuffix 0..1stringbuildingNumberSuffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
... iso21090-ADXP-additionalLocator 0..1stringadditionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*AddressA 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
... nl-address-official 0..1booleanExtension
URL: http://fhir.nl/fhir/StructureDefinition/nl-address-official
... iso21090-ADXP-streetName 0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
... iso21090-ADXP-houseNumber 0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
... iso21090-ADXP-buildingNumberSuffix 0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
... iso21090-ADXP-additionalLocator 0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
... use ?! 0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
... type 0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
... text 0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
... line 0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
... city 0..1stringName of city, town etc.
Example: Erewhon
... district 0..1stringDistrict name (aka county)
Example: Madison
... state 0..1stringSub-unit of country (abbreviations ok)
... postalCode I0..1stringPostal code for area
nl-postal-code-pattern: Dutch postal code pattern 'nnnnAA'
Example: 9132
... country 0..1stringCountry (can be ISO 3166 3 letter code)
... period 0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

todo

Differential View

This structure is derived from Address.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*AddressA 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
... city 0..1stringName of city, town etc.
Example: Erewhon
... district 0..1stringDistrict name (aka county)
Example: Madison
... state 0..1stringSub-unit of country (abbreviations ok)
... postalCode I0..1stringPostal code for area
nl-postal-code-pattern: Dutch postal code pattern 'nnnnAA'
Example: 9132
... nl-address-official 0..1booleanMark an address as an 'officially registered' address.
URL: http://fhir.nl/fhir/StructureDefinition/nl-address-official
... iso21090-ADXP-streetName 0..1stringstreetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
... iso21090-ADXP-houseNumber 0..1stringhouseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
... iso21090-ADXP-buildingNumberSuffix 0..1stringbuildingNumberSuffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
... iso21090-ADXP-additionalLocator 0..1stringadditionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*AddressA 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
... nl-address-official 0..1booleanExtension
URL: http://fhir.nl/fhir/StructureDefinition/nl-address-official
... iso21090-ADXP-streetName 0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
... iso21090-ADXP-houseNumber 0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
... iso21090-ADXP-buildingNumberSuffix 0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
... iso21090-ADXP-additionalLocator 0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
... use ?! 0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
... type 0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
... text 0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
... line 0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
... city 0..1stringName of city, town etc.
Example: Erewhon
... district 0..1stringDistrict name (aka county)
Example: Madison
... state 0..1stringSub-unit of country (abbreviations ok)
... postalCode I0..1stringPostal code for area
nl-postal-code-pattern: Dutch postal code pattern 'nnnnAA'
Example: 9132
... country 0..1stringCountry (can be ISO 3166 3 letter code)
... period 0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

L.??.2 Terminology Bindings

PathNameConformanceValueSet
Address.useAddressUserequiredAddressUse
Address.typeAddressTyperequiredAddressType

L.??.3 Constraints

IdPathDetailsRequirements
nl-line-if-line-partsAddressAddress.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-partsAddressAddress.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-patternAddress.postalCodeDutch postal code pattern 'nnnnAA'
XPath: not(../f:country[lower-case(@value)=('nl','nld','nederland')]) or matches(@value,'^\d{4}[A-Z]{2}$')
.