This page is part of the MyHealth@Eu Core (v1.0.0: Wave 9) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

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

Data Type Profile: Address (MyHealth@EU)

This profile sets minimum expectations for the Address dataType common to most of the use cases.

Usages:

• Use this DataType Profile: Location (Core), Organization (Core) and Patient (Core)

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Address		0..*	AddressEu	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
use	?!Σ	0..1	code	Purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
country	OΣ	0..1	string	Country (ISO 3166 2 letter code) Obligations Actor SHALL:handle MyHealth@EU Handler
Slices for extension				Content/Rules for all slices
extension:countryCode		0..1	(Complex)	code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
value[x]		1..1	Coding	Value of extension Binding: eHDSI Country (required)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Address.country.extension:countryCode.​value[x]	Base	required	eHDSI Country	📦9.1.0	MyHealthEu MVC package v9.1

Constraints

Id	Grade	Path(s)	Description	Expression
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 AddressEu

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Address		0..*	AddressEu	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
country	O	0..1	string	Country (ISO 3166 2 letter code) Obligations Actor SHALL:handle MyHealth@EU Handler
Slices for extension				Content/Rules for all slices
extension:countryCode		0..1	CodedString	code for string
value[x]		1..1	Coding	Value of extension Binding: eHDSI Country (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Address.country.extension:countryCode.​value[x]	Base	required	eHDSI Country	📦9.1.0	MyHealthEu MVC package v9.1

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Address		0..*	AddressEu	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	Purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	Address type (postal | physical) 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
extension:streetName		0..*	string	streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
extension:houseNumber		0..*	string	houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
extension: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	City 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 Example General: 9132
country	OΣ	0..1	string	Country (ISO 3166 2 letter code) Obligations Actor SHALL:handle MyHealth@EU Handler
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension: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		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
value[x]		1..1	Coding	Value of extension Binding: eHDSI Country (required)
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	Status	Usage	ValueSet	Version	Source
Address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Address.country.extension:countryCode.​value[x]	Base	required	eHDSI Country	📦9.1.0	MyHealthEu MVC package v9.1

Constraints

Id	Grade	Path(s)	Description	Expression
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 AddressEu

Summary

Maturity: 2

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Address		0..*	AddressEu	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
use	?!Σ	0..1	code	Purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
country	OΣ	0..1	string	Country (ISO 3166 2 letter code) Obligations Actor SHALL:handle MyHealth@EU Handler
Slices for extension				Content/Rules for all slices
extension:countryCode		0..1	(Complex)	code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
value[x]		1..1	Coding	Value of extension Binding: eHDSI Country (required)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Address.country.extension:countryCode.​value[x]	Base	required	eHDSI Country	📦9.1.0	MyHealthEu MVC package v9.1

Constraints

Id	Grade	Path(s)	Description	Expression
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()

Differential View

This structure is derived from AddressEu

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Address		0..*	AddressEu	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
country	O	0..1	string	Country (ISO 3166 2 letter code) Obligations Actor SHALL:handle MyHealth@EU Handler
Slices for extension				Content/Rules for all slices
extension:countryCode		0..1	CodedString	code for string
value[x]		1..1	Coding	Value of extension Binding: eHDSI Country (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Address.country.extension:countryCode.​value[x]	Base	required	eHDSI Country	📦9.1.0	MyHealthEu MVC package v9.1

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Address		0..*	AddressEu	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	Purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	Address type (postal | physical) 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
extension:streetName		0..*	string	streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
extension:houseNumber		0..*	string	houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
extension: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	City 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 Example General: 9132
country	OΣ	0..1	string	Country (ISO 3166 2 letter code) Obligations Actor SHALL:handle MyHealth@EU Handler
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension: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		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
value[x]		1..1	Coding	Value of extension Binding: eHDSI Country (required)
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	Status	Usage	ValueSet	Version	Source
Address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Address.country.extension:countryCode.​value[x]	Base	required	eHDSI Country	📦9.1.0	MyHealthEu MVC package v9.1

Constraints

Id	Grade	Path(s)	Description	Expression
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 AddressEu

Summary

Maturity: 2

Other representations of profile: CSV, Excel, Schematron