HL7 Europe Base Profiles, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.0.1-ci built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/base/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Data Type Profile: Address (EU)

This profile extends the Address data type for supporting streetname, housenumber and postal box.

Usage:

• Use this DataType Constraint: Organization (EU base), Patient (EU base) and Practitioner (EU base)

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		0..*	Address	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
line
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
streetName		0..*	string	streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
houseNumber		0..*	string	houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
postBox		0..*	string	postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
country
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
countryCode		0..1	(Complex)	code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
value[x]		1..1	Coding	Value of extension Binding: Iso316612 (preferred)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Address.country.extension:countryCode.value[x]	preferred	Iso316612 http://hl7.org/fhir/ValueSet/iso3166-1-2 from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
Address		0..*	Address	An address expressed using postal conventions (as opposed to GPS or other location definition formats) ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). ele-1: All FHIR elements must have a @value or children Example General: home
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|5.0.0 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

Name	Flags	Card.	Type	Description & Constraints
Address		0..*	Address	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home
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..*	string	streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
houseNumber		0..*	string	houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
postBox		0..*	string	postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
value		0..1	string	Primitive value for string Max Length:1048576
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. may be ISO 3166 2 or 3 letter code)
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)	code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
value[x]		1..1	Coding	Value of extension Binding: Iso316612 (preferred)
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	URI
Address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|5.0.0 from the FHIR Standard
Address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|5.0.0 from the FHIR Standard
Address.country.extension:countryCode.value[x]	preferred	Iso316612 http://hl7.org/fhir/ValueSet/iso3166-1-2 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Address

Summary

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
• http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
• http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
• http://hl7.org/fhir/StructureDefinition/iso21090-codedString

Maturity: 2

Differential View

This structure is derived from Address

Name	Flags	Card.	Type	Description & Constraints
Address		0..*	Address	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
line
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
streetName		0..*	string	streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
houseNumber		0..*	string	houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
postBox		0..*	string	postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
country
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
countryCode		0..1	(Complex)	code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
value[x]		1..1	Coding	Value of extension Binding: Iso316612 (preferred)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Address.country.extension:countryCode.value[x]	preferred	Iso316612 http://hl7.org/fhir/ValueSet/iso3166-1-2 from the FHIR Standard

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Address		0..*	Address	An address expressed using postal conventions (as opposed to GPS or other location definition formats) ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). ele-1: All FHIR elements must have a @value or children Example General: home
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|5.0.0 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Address		0..*	Address	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home
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..*	string	streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
houseNumber		0..*	string	houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
postBox		0..*	string	postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
value		0..1	string	Primitive value for string Max Length:1048576
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. may be ISO 3166 2 or 3 letter code)
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)	code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
value[x]		1..1	Coding	Value of extension Binding: Iso316612 (preferred)
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	URI
Address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|5.0.0 from the FHIR Standard
Address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|5.0.0 from the FHIR Standard
Address.country.extension:countryCode.value[x]	preferred	Iso316612 http://hl7.org/fhir/ValueSet/iso3166-1-2 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Address

Summary

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
• http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
• http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
• http://hl7.org/fhir/StructureDefinition/iso21090-codedString

Maturity: 2

Other representations of profile: CSV, Excel, Schematron