nl-core-address - Nictiz FHIR NL STU3 Zib2017 v1.3.15

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 2024-04-09				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.

Usage:

Use this DataType Constraint: nl-core-location, nl-core-organization, nl-core-patient, nl-core-person... Show 2 more

Formal Views of Profile Content

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

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

This structure is derived from Address

Name	Flags	Card.	Type	Description & Constraints
Address	C	0..*	Address	Address information 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 Example Example of a vacation home address: {"extension":[{"url":"http://fhir.nl/fhir/StructureDefinition/nl-core-address-official","valueBoolean":false}],"use":"temp","_use":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-AD-use","valueCode":"HV"}]},"line":["Binnenkant 12A Hoog"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"12"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix","valueString":"A"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID","valueString":"Hoog"}]}],"city":"Amsterdam","state":"NH","postalCode":"1000AA","country":"NLD"} Example Example of a primary home address: {"extension":[{"url":"http://fhir.nl/fhir/StructureDefinition/nl-core-address-official","valueBoolean":true}],"use":"home","line":["Binnenkant to 10"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator","valueString":"to"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"10"}]}],"city":"Amsterdam","state":"NH","postalCode":"1001AA","country":"NLD"}
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
AD_use		0..1	(Complex)	Further define the address use with the exact HCIM code. URL: http://hl7.org/fhir/StructureDefinition/iso21090-AD-use
valueCode:valueCode		0..1	code	Value of extension
type		0..1	code	postal \| physical \| both
line
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
streetName		0..1	(Complex)	streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
valueString:valueString		0..1	string	Value of extension
houseNumber		0..1	(Complex)	houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
valueString:valueString		0..1	string	Value of extension
buildingNumbersuffix		0..*	(Complex)	buildingNumberSuffix URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
valueString:valueString		0..1	string	Value of extension
unitID		0..1	(Complex)	unitID URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
valueString:valueString		0..1	string	Value of extension
additionalLocator		0..1	(Complex)	additionalLocator URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
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 nl-postal-code-pattern: Dutch postal code pattern 'nnnnAA' Example Example postcode: 9132AG
country		0..1	string	Country (can be ISO 3166 3 letter code) Example Example country: NLD
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
countryCode		0..1	(Complex)	CountryGBACode \| CountryISOCode URL: http://nictiz.nl/fhir/StructureDefinition/code-specification
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
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Address.country.extension:countryCode.valueCodeableConcept:valueCodeableConcept.coding:countryGBACodelist	extensible	Pattern: 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:countryISOCodelist	extensible	Pattern: 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

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
Address	C	0..*	Address	Address information 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 Example Example of a vacation home address: {"extension":[{"url":"http://fhir.nl/fhir/StructureDefinition/nl-core-address-official","valueBoolean":false}],"use":"temp","_use":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-AD-use","valueCode":"HV"}]},"line":["Binnenkant 12A Hoog"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"12"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix","valueString":"A"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID","valueString":"Hoog"}]}],"city":"Amsterdam","state":"NH","postalCode":"1000AA","country":"NLD"} Example Example of a primary home address: {"extension":[{"url":"http://fhir.nl/fhir/StructureDefinition/nl-core-address-official","valueBoolean":true}],"use":"home","line":["Binnenkant to 10"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator","valueString":"to"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"10"}]}],"city":"Amsterdam","state":"NH","postalCode":"1001AA","country":"NLD"}
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
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): The use of an address Example General: home
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
AD_use		0..1	(Complex)	Further define the address use with the exact HCIM code. URL: http://hl7.org/fhir/StructureDefinition/iso21090-AD-use
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-AD-use"
valueCode:valueCode		0..1	code	Value of extension Binding: PostalAddressUse (required): Uses of an address not included in Address.use
type	Σ	0..1	code	postal \| physical \| both Binding: AddressType (required): The type of an address (physical / postal) Example General: both
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 nl-postal-code-pattern: Dutch postal code pattern 'nnnnAA' Example General: 9132 Example Example postcode: 9132AG
country	Σ	0..1	string	Country (can be ISO 3166 3 letter code) Example Example country: NLD
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
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
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Address.use	required	AddressUse `http://hl7.org/fhir/ValueSet/address-use` from the FHIR Standard
Address.use.extension:AD_use.valueCode:valueCode	required	PostalAddressUse `http://hl7.org/fhir/ValueSet/postal-address-use` from the FHIR Standard
Address.type	required	AddressType `http://hl7.org/fhir/ValueSet/address-type` from the FHIR Standard
Address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryGBACodelist	extensible	Pattern: 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:countryISOCodelist	extensible	Pattern: 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

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
Address	C	0..*	Address	Address information 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 Example Example of a vacation home address: {"extension":[{"url":"http://fhir.nl/fhir/StructureDefinition/nl-core-address-official","valueBoolean":false}],"use":"temp","_use":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-AD-use","valueCode":"HV"}]},"line":["Binnenkant 12A Hoog"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"12"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix","valueString":"A"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID","valueString":"Hoog"}]}],"city":"Amsterdam","state":"NH","postalCode":"1000AA","country":"NLD"} Example Example of a primary home address: {"extension":[{"url":"http://fhir.nl/fhir/StructureDefinition/nl-core-address-official","valueBoolean":true}],"use":"home","line":["Binnenkant to 10"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator","valueString":"to"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"10"}]}],"city":"Amsterdam","state":"NH","postalCode":"1001AA","country":"NLD"}
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
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): The use of an address Example General: home
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
AD_use		0..1	(Complex)	Further define the address use with the exact HCIM code. URL: http://hl7.org/fhir/StructureDefinition/iso21090-AD-use
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-AD-use"
valueCode:valueCode		0..1	code	Value of extension Binding: PostalAddressUse (required): Uses of an address not included in Address.use
value		0..1	code	Primitive value for code
type	Σ	0..1	code	postal \| physical \| both Binding: AddressType (required): The type of an address (physical / postal) Example General: both
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
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"
valueString:valueString		0..1	string	Value of 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"
valueString:valueString		0..1	string	Value of 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"
valueString:valueString		0..1	string	Value of 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"
valueString:valueString		0..1	string	Value of 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"
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 nl-postal-code-pattern: Dutch postal code pattern 'nnnnAA' Example General: 9132 Example Example postcode: 9132AG
country	Σ	0..1	string	Country (can be ISO 3166 3 letter code) 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
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"}
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Address.use	required	AddressUse `http://hl7.org/fhir/ValueSet/address-use` from the FHIR Standard
Address.use.extension:AD_use.valueCode:valueCode	required	PostalAddressUse `http://hl7.org/fhir/ValueSet/postal-address-use` from the FHIR Standard
Address.type	required	AddressType `http://hl7.org/fhir/ValueSet/address-type` from the FHIR Standard
Address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryGBACodelist	extensible	Pattern: 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:countryISOCodelist	extensible	Pattern: 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

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:

The element 1 is sliced based on the value of Address.country.extension.valueCodeableConcept.coding

Differential View

This structure is derived from Address

Name	Flags	Card.	Type	Description & Constraints
Address	C	0..*	Address	Address information 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 Example Example of a vacation home address: {"extension":[{"url":"http://fhir.nl/fhir/StructureDefinition/nl-core-address-official","valueBoolean":false}],"use":"temp","_use":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-AD-use","valueCode":"HV"}]},"line":["Binnenkant 12A Hoog"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"12"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix","valueString":"A"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID","valueString":"Hoog"}]}],"city":"Amsterdam","state":"NH","postalCode":"1000AA","country":"NLD"} Example Example of a primary home address: {"extension":[{"url":"http://fhir.nl/fhir/StructureDefinition/nl-core-address-official","valueBoolean":true}],"use":"home","line":["Binnenkant to 10"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator","valueString":"to"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"10"}]}],"city":"Amsterdam","state":"NH","postalCode":"1001AA","country":"NLD"}
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
AD_use		0..1	(Complex)	Further define the address use with the exact HCIM code. URL: http://hl7.org/fhir/StructureDefinition/iso21090-AD-use
valueCode:valueCode		0..1	code	Value of extension
type		0..1	code	postal \| physical \| both
line
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
streetName		0..1	(Complex)	streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
valueString:valueString		0..1	string	Value of extension
houseNumber		0..1	(Complex)	houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
valueString:valueString		0..1	string	Value of extension
buildingNumbersuffix		0..*	(Complex)	buildingNumberSuffix URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
valueString:valueString		0..1	string	Value of extension
unitID		0..1	(Complex)	unitID URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
valueString:valueString		0..1	string	Value of extension
additionalLocator		0..1	(Complex)	additionalLocator URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
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 nl-postal-code-pattern: Dutch postal code pattern 'nnnnAA' Example Example postcode: 9132AG
country		0..1	string	Country (can be ISO 3166 3 letter code) Example Example country: NLD
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
countryCode		0..1	(Complex)	CountryGBACode \| CountryISOCode URL: http://nictiz.nl/fhir/StructureDefinition/code-specification
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
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Address.country.extension:countryCode.valueCodeableConcept:valueCodeableConcept.coding:countryGBACodelist	extensible	Pattern: 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:countryISOCodelist	extensible	Pattern: 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

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
Address	C	0..*	Address	Address information 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 Example Example of a vacation home address: {"extension":[{"url":"http://fhir.nl/fhir/StructureDefinition/nl-core-address-official","valueBoolean":false}],"use":"temp","_use":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-AD-use","valueCode":"HV"}]},"line":["Binnenkant 12A Hoog"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"12"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix","valueString":"A"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID","valueString":"Hoog"}]}],"city":"Amsterdam","state":"NH","postalCode":"1000AA","country":"NLD"} Example Example of a primary home address: {"extension":[{"url":"http://fhir.nl/fhir/StructureDefinition/nl-core-address-official","valueBoolean":true}],"use":"home","line":["Binnenkant to 10"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator","valueString":"to"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"10"}]}],"city":"Amsterdam","state":"NH","postalCode":"1001AA","country":"NLD"}
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
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): The use of an address Example General: home
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
AD_use		0..1	(Complex)	Further define the address use with the exact HCIM code. URL: http://hl7.org/fhir/StructureDefinition/iso21090-AD-use
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-AD-use"
valueCode:valueCode		0..1	code	Value of extension Binding: PostalAddressUse (required): Uses of an address not included in Address.use
type	Σ	0..1	code	postal \| physical \| both Binding: AddressType (required): The type of an address (physical / postal) Example General: both
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 nl-postal-code-pattern: Dutch postal code pattern 'nnnnAA' Example General: 9132 Example Example postcode: 9132AG
country	Σ	0..1	string	Country (can be ISO 3166 3 letter code) Example Example country: NLD
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
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
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Address.use	required	AddressUse `http://hl7.org/fhir/ValueSet/address-use` from the FHIR Standard
Address.use.extension:AD_use.valueCode:valueCode	required	PostalAddressUse `http://hl7.org/fhir/ValueSet/postal-address-use` from the FHIR Standard
Address.type	required	AddressType `http://hl7.org/fhir/ValueSet/address-type` from the FHIR Standard
Address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryGBACodelist	extensible	Pattern: 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:countryISOCodelist	extensible	Pattern: 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

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
Address	C	0..*	Address	Address information 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 Example Example of a vacation home address: {"extension":[{"url":"http://fhir.nl/fhir/StructureDefinition/nl-core-address-official","valueBoolean":false}],"use":"temp","_use":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-AD-use","valueCode":"HV"}]},"line":["Binnenkant 12A Hoog"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"12"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix","valueString":"A"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID","valueString":"Hoog"}]}],"city":"Amsterdam","state":"NH","postalCode":"1000AA","country":"NLD"} Example Example of a primary home address: {"extension":[{"url":"http://fhir.nl/fhir/StructureDefinition/nl-core-address-official","valueBoolean":true}],"use":"home","line":["Binnenkant to 10"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator","valueString":"to"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"10"}]}],"city":"Amsterdam","state":"NH","postalCode":"1001AA","country":"NLD"}
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
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): The use of an address Example General: home
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
AD_use		0..1	(Complex)	Further define the address use with the exact HCIM code. URL: http://hl7.org/fhir/StructureDefinition/iso21090-AD-use
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-AD-use"
valueCode:valueCode		0..1	code	Value of extension Binding: PostalAddressUse (required): Uses of an address not included in Address.use
value		0..1	code	Primitive value for code
type	Σ	0..1	code	postal \| physical \| both Binding: AddressType (required): The type of an address (physical / postal) Example General: both
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
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"
valueString:valueString		0..1	string	Value of 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"
valueString:valueString		0..1	string	Value of 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"
valueString:valueString		0..1	string	Value of 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"
valueString:valueString		0..1	string	Value of 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"
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 nl-postal-code-pattern: Dutch postal code pattern 'nnnnAA' Example General: 9132 Example Example postcode: 9132AG
country	Σ	0..1	string	Country (can be ISO 3166 3 letter code) 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
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"}
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Address.use	required	AddressUse `http://hl7.org/fhir/ValueSet/address-use` from the FHIR Standard
Address.use.extension:AD_use.valueCode:valueCode	required	PostalAddressUse `http://hl7.org/fhir/ValueSet/postal-address-use` from the FHIR Standard
Address.type	required	AddressType `http://hl7.org/fhir/ValueSet/address-type` from the FHIR Standard
Address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryGBACodelist	extensible	Pattern: 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:countryISOCodelist	extensible	Pattern: 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

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:

The element 1 is sliced based on the value of Address.country.extension.valueCodeableConcept.coding

Other representations of profile: CSV, Excel, Schematron

IG © 2023+ HL7 Netherlands. Package zibs2017#1.3.15 based on FHIR 3.0.2. Generated 2024-04-09
Links: Table of Contents | QA Report