CH.FHIR.IG.CH-CORE\CH Core Postal Address Profile

CH Core (R4)
1.0.0 - Trial use

This page is part of the CH Core (R4) (v1.0.0: STU 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 6.0.0-ballot. For a full list of available versions, see the Directory of published versions

StructureDefinition: CHCoreAddressECH10

Postal address according to eCH-0010

The official URL for this profile is:

http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-address-ech-10

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
All

This structure is derived from CHCoreAddress

Summary

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

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	I	0..*	CHCoreAddress	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	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!ΣI	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required) Example General: home
type	ΣI	0..1	code	postal Binding: AddressType (required) Fixed Value: postal
text	ΣI	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	ΣI	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)
extension	I	0..*	Extension	Extension Slice: Ordered, Open by value:url, value:value
ch-ext-ech-10-linetype	I	0..1	code	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	I	0..0
url		1..1	uri	"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Fixed Value: addressLine1
value[x]:valueCode	I	0..1	code	Value of extension Binding: eCH-010 Address Line Type (required)
ch-ext-ech-10-linetype	I	0..1	code	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	I	0..0
url		1..1	uri	"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Fixed Value: addressLine2
value[x]:valueCode	I	0..1	code	Value of extension Binding: eCH-010 Address Line Type (required)
ch-ext-ech-10-linetype	I	0..1	code	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	I	0..0
url		1..1	uri	"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Fixed Value: street
value[x]:valueCode	I	0..1	code	Value of extension Binding: eCH-010 Address Line Type (required)
iso21090-ADXP-houseNumber	I	0..1	string	houseNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
iso21090-ADXP-unitID	I	0..1	string	unitID, dwellingNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
ch-ext-ech-10-linetype	I	0..1	code	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	I	0..0
url		1..1	uri	"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Fixed Value: postOfficeBoxText
value[x]:valueCode	I	0..1	code	Value of extension Binding: eCH-010 Address Line Type (required)
iso21090-ADXP-postBox	I	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	ΣI	1..1	string	Name of city, town etc. Example General: Erewhon
id		0..1	string	xml:id (or equivalent in JSON)
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
ch-ext-ech-7-municipalityid	I	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	ΣI	0..1	string	District name (aka county) Example General: Madison
state	ΣI	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	ΣI	1..1	string	Postal code for area Example General: 9132
country	ΣI	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)
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
iso21090-SC-coding	I	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) 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

This structure is derived from CHCoreAddress

Summary

Mandatory: 3 elements
Fixed Value: 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

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Address	I	0..*	CHCoreAddress	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	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!ΣI	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required) Example General: home
type	ΣI	0..1	code	postal Binding: AddressType (required) Fixed Value: postal
text	ΣI	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	ΣI	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)
extension	I	0..*	Extension	Extension Slice: Ordered, Open by value:url, value:value
ch-ext-ech-10-linetype	I	0..1	code	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	I	0..0
url		1..1	uri	"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Fixed Value: addressLine1
value[x]:valueCode	I	0..1	code	Value of extension Binding: eCH-010 Address Line Type (required)
ch-ext-ech-10-linetype	I	0..1	code	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	I	0..0
url		1..1	uri	"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Fixed Value: addressLine2
value[x]:valueCode	I	0..1	code	Value of extension Binding: eCH-010 Address Line Type (required)
ch-ext-ech-10-linetype	I	0..1	code	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	I	0..0
url		1..1	uri	"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Fixed Value: street
value[x]:valueCode	I	0..1	code	Value of extension Binding: eCH-010 Address Line Type (required)
iso21090-ADXP-houseNumber	I	0..1	string	houseNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
iso21090-ADXP-unitID	I	0..1	string	unitID, dwellingNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
ch-ext-ech-10-linetype	I	0..1	code	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	I	0..0
url		1..1	uri	"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Fixed Value: postOfficeBoxText
value[x]:valueCode	I	0..1	code	Value of extension Binding: eCH-010 Address Line Type (required)
iso21090-ADXP-postBox	I	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	ΣI	1..1	string	Name of city, town etc. Example General: Erewhon
id		0..1	string	xml:id (or equivalent in JSON)
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
ch-ext-ech-7-municipalityid	I	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	ΣI	0..1	string	District name (aka county) Example General: Madison
state	ΣI	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	ΣI	1..1	string	Postal code for area Example General: 9132
country	ΣI	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)
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
iso21090-SC-coding	I	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) 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

Other representations of profile: Schematron

Terminology Bindings

Path	Conformance	ValueSet / Code
Address.use	required	AddressUse
Address.type	required	Fixed Value: postal
Address.line.extension:addressLine1.value[x]:valueCode	required	ECH10AddressLine
Address.line.extension:addressLine2.value[x]:valueCode	required	ECH10AddressLine
Address.line.extension:street.value[x]:valueCode	required	ECH10AddressLine
Address.line.extension:postOfficeBoxText.value[x]:valueCode	required	ECH10AddressLine

Constraints

Id	Path	Details	Requirements
ele-1	Address	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Address.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Address.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.line	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.line.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Address.line.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Address.line.extension:addressLine1	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Address.line.extension:addressLine1	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Address.line.extension:addressLine1.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.line.extension:addressLine1.value[x]:valueCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.line.extension:addressLine2	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Address.line.extension:addressLine2	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Address.line.extension:addressLine2.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.line.extension:addressLine2.value[x]:valueCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.line.extension:street	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Address.line.extension:street	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Address.line.extension:street.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.line.extension:street.value[x]:valueCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.line.extension:houseNumber	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Address.line.extension:houseNumber	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Address.line.extension:unitID	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Address.line.extension:unitID	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Address.line.extension:postOfficeBoxText	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Address.line.extension:postOfficeBoxText	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Address.line.extension:postOfficeBoxText.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.line.extension:postOfficeBoxText.value[x]:valueCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.line.extension:postOfficeBoxNumber	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Address.line.extension:postOfficeBoxNumber	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Address.city	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.city.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Address.city.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Address.city.extension:bfs	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Address.city.extension:bfs	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Address.district	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.state	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.postalCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.country	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.country.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Address.country.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Address.country.extension:countrycode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Address.country.extension:countrycode	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ch-addr-1	Address.country.extension:countrycode	ISO Country Alpha-2 or ISO Country Alpha-3 code : ((valueCoding.code.length()=2) and valueCoding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((valueCoding.code.length() = 3) and valueCoding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))

IG © 2020+ HL7 Switzerland. Package ch.fhir.ig.ch-core#1.0.0 based on FHIR 4.0.1. Generated 2020-04-21
Links: Table of Contents | QA Report