This page is part of the CH Core (R4) (v5.0.0-ballot: STU 5 Ballot 1) 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

Data Type Profile: CH Core Postal Address

Postal address according to eCH-0010

Usage:

• Use this DataType Constraint: CH Core Location and CH Core Patient

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 CHCoreAddress

Name	Flags	Card.	Type	Description & Constraints
Address		0..*	CHCoreAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
type		0..1	code	postal Fixed Value: postal
city		1..1	string	Name of city, town etc.
postalCode		1..1	string	Postal code for area
country		1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Address	C	0..*	CHCoreAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats) ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used.
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal Binding: AddressType (required): The type of an address (physical / postal). Fixed Value: postal
city	Σ	1..1	string	Name of city, town etc. Example General: Erewhon
Slices for extension				Content/Rules for all slices
bfs		0..1	string	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
postalCode	Σ	1..1	string	Postal code for area Example General: 9132
country	Σ	1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Slices for extension				Content/Rules for all slices
countrycode	C	0..1	Coding	ISO Country Alpha-2 or ISO Country Alpha-3 code URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding Binding: (unbound) (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc. ch-addr-1: ISO Country Alpha-2 or ISO Country Alpha-3 code
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Address.type	required	Fixed Value: postal http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ch-addr-1	error	Address.country.extension:countrycode	ISO Country Alpha-2 or ISO Country Alpha-3 code : ((value.code.length()=2) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((value.code.length() = 3) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
ch-addr-2	error	Address	For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used. : country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').empty() or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH') = false) or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH').exists() and (state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation')))
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()

Name	Flags	Card.	Type	Description & Constraints
Address	C	0..*	CHCoreAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats) ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used.
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	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal Binding: AddressType (required): The type of an address (physical / postal). Fixed Value: postal
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: Ordered, Open by value:url, value:value
addressLine1		0..1	(Complex)	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
Slices for value[x]		1..1	code	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCode		1..1	code	Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: addressLine1
addressLine2		0..1	(Complex)	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
Slices for value[x]		1..1	code	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCode		1..1	code	Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: addressLine2
street		0..1	(Complex)	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
Slices for value[x]		1..1	code	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCode		1..1	code	Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: street
streetName		0..1	string	street part of the street line, e.g. withouth housenumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
houseNumber		0..1	string	houseNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
unitID		0..1	string	unitID, dwellingNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
postOfficeBoxText		0..1	(Complex)	Postbox addresses need an postbox text and optional postbox number URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
Slices for value[x]		1..1	code	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCode		1..1	code	Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: postOfficeBoxText
postOfficeBoxNumber		0..1	string	Optional postOfficeBoxNumber as a separate part of the postOfficeBoxText URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
value		0..1	string	Primitive value for string Max Length: 1048576
city	Σ	1..1	string	Name of city, town etc. Example General: Erewhon
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
bfs		0..1	string	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
value		0..1	string	Primitive value for string Max Length: 1048576
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok) Binding: eCH-0007 Canton Abbreviation incl. FL (Fürstentum Liechtenstein) (example): Use these values for a Swiss or Liechtenstein address
postalCode	Σ	1..1	string	Postal code for area Example General: 9132
country	Σ	1..1	string	Country (e.g. can 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	C	0..1	Coding	ISO Country Alpha-2 or ISO Country Alpha-3 code URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding Binding: (unbound) (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc. ch-addr-1: ISO Country Alpha-2 or ISO Country Alpha-3 code
value		0..1	string	Primitive value for string Max Length: 1048576
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Address.type	required	Fixed Value: postal http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Address.line.extension:addressLine1.value[x]:valueCode	extensible	Fixed Value: addressLine1 http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Address.line.extension:addressLine2.value[x]:valueCode	extensible	Fixed Value: addressLine2 http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Address.line.extension:street.value[x]:valueCode	extensible	Fixed Value: street http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Address.line.extension:postOfficeBoxText.value[x]:valueCode	extensible	Fixed Value: postOfficeBoxText http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Address.state	example	ECH007CantonFLAbbreviation http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonflabbreviation

Constraints

Id	Grade	Path(s)	Details	Requirements
ch-addr-1	error	Address.country.extension:countrycode	ISO Country Alpha-2 or ISO Country Alpha-3 code : ((value.code.length()=2) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((value.code.length() = 3) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
ch-addr-2	error	Address	For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used. : country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').empty() or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH') = false) or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH').exists() and (state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation')))
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 CHCoreAddress

Summary

Mandatory: 3 elements
Fixed: 1 element
Prohibited: 1 element

Differential View

This structure is derived from CHCoreAddress

Name	Flags	Card.	Type	Description & Constraints
Address		0..*	CHCoreAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
type		0..1	code	postal Fixed Value: postal
city		1..1	string	Name of city, town etc.
postalCode		1..1	string	Postal code for area
country		1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period		0..0
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Address	C	0..*	CHCoreAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats) ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used.
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal Binding: AddressType (required): The type of an address (physical / postal). Fixed Value: postal
city	Σ	1..1	string	Name of city, town etc. Example General: Erewhon
Slices for extension				Content/Rules for all slices
bfs		0..1	string	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
postalCode	Σ	1..1	string	Postal code for area Example General: 9132
country	Σ	1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Slices for extension				Content/Rules for all slices
countrycode	C	0..1	Coding	ISO Country Alpha-2 or ISO Country Alpha-3 code URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding Binding: (unbound) (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc. ch-addr-1: ISO Country Alpha-2 or ISO Country Alpha-3 code
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Address.type	required	Fixed Value: postal http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ch-addr-1	error	Address.country.extension:countrycode	ISO Country Alpha-2 or ISO Country Alpha-3 code : ((value.code.length()=2) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((value.code.length() = 3) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
ch-addr-2	error	Address	For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used. : country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').empty() or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH') = false) or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH').exists() and (state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation')))
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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Address	C	0..*	CHCoreAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats) ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used.
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	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal Binding: AddressType (required): The type of an address (physical / postal). Fixed Value: postal
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: Ordered, Open by value:url, value:value
addressLine1		0..1	(Complex)	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
Slices for value[x]		1..1	code	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCode		1..1	code	Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: addressLine1
addressLine2		0..1	(Complex)	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
Slices for value[x]		1..1	code	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCode		1..1	code	Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: addressLine2
street		0..1	(Complex)	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
Slices for value[x]		1..1	code	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCode		1..1	code	Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: street
streetName		0..1	string	street part of the street line, e.g. withouth housenumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
houseNumber		0..1	string	houseNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
unitID		0..1	string	unitID, dwellingNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
postOfficeBoxText		0..1	(Complex)	Postbox addresses need an postbox text and optional postbox number URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
Slices for value[x]		1..1	code	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCode		1..1	code	Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: postOfficeBoxText
postOfficeBoxNumber		0..1	string	Optional postOfficeBoxNumber as a separate part of the postOfficeBoxText URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
value		0..1	string	Primitive value for string Max Length: 1048576
city	Σ	1..1	string	Name of city, town etc. Example General: Erewhon
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
bfs		0..1	string	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
value		0..1	string	Primitive value for string Max Length: 1048576
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok) Binding: eCH-0007 Canton Abbreviation incl. FL (Fürstentum Liechtenstein) (example): Use these values for a Swiss or Liechtenstein address
postalCode	Σ	1..1	string	Postal code for area Example General: 9132
country	Σ	1..1	string	Country (e.g. can 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	C	0..1	Coding	ISO Country Alpha-2 or ISO Country Alpha-3 code URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding Binding: (unbound) (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc. ch-addr-1: ISO Country Alpha-2 or ISO Country Alpha-3 code
value		0..1	string	Primitive value for string Max Length: 1048576
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Address.type	required	Fixed Value: postal http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Address.line.extension:addressLine1.value[x]:valueCode	extensible	Fixed Value: addressLine1 http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Address.line.extension:addressLine2.value[x]:valueCode	extensible	Fixed Value: addressLine2 http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Address.line.extension:street.value[x]:valueCode	extensible	Fixed Value: street http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Address.line.extension:postOfficeBoxText.value[x]:valueCode	extensible	Fixed Value: postOfficeBoxText http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype
Address.state	example	ECH007CantonFLAbbreviation http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonflabbreviation

Constraints

Id	Grade	Path(s)	Details	Requirements
ch-addr-1	error	Address.country.extension:countrycode	ISO Country Alpha-2 or ISO Country Alpha-3 code : ((value.code.length()=2) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((value.code.length() = 3) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
ch-addr-2	error	Address	For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used. : country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').empty() or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH') = false) or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH').exists() and (state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation')))
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 CHCoreAddress

Summary

Mandatory: 3 elements
Fixed: 1 element
Prohibited: 1 element

Other representations of profile: CSV, Excel, Schematron