CH Core (R4)
7.0.0-ballot - ballot Switzerland flag

CH Core (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 7.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-core/ and changes regularly. See the Directory of published versions

Data Type Profile: CH Core Address

Official URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-address Version: 7.0.0-ballot
Active as of 2026-10-21 Computable Name: CHCoreAddress

Copyright/Legal: CC0-1.0

address incorporating eCH-0010 postal address extensions

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Address C 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Constraints: ch-addr-2
Address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Address.city This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Address.city.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.city.Slices for extension.extension:bfs 0..1 string Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
Address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Address.state This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: eCH-0007 Canton Abbreviation (example): Use these values for a Swiss or Liechtenstein address
Address.postalCode This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Address.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: BFS Verzeichnis der Staaten und Gebiete (preferred)
Address.country.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.country.Slices for extension.extension:countrycode C 0..1 (Complex) ISO Country Alpha-2 or ISO Country Alpha-3 code
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
Constraints: ch-addr-1
Address.country.Slices for extension.extension:countrycode.extension 0..0 Extension
Slice: Unordered, Open by value:url
Address.country.Slices for extension.extension:countrycode.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
Address.country.Slices for extension.extension:countrycode.value[x] 1..1 Coding Value of extension
Binding: BFS Verzeichnis der Staaten und Gebiete (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Address.use Base required AddressUse 📍4.0.1 FHIR Std.
Address.state Base example eCH-0007 Canton Abbreviation 📦3.4.0 CH Term v3.4
Address.country Base preferred BFS Verzeichnis der Staaten und Gebiete 📦3.4.0 CH Term v3.4
Address.country.extension:countrycode.​value[x] Base extensible BFS Verzeichnis der Staaten und Gebiete 📦3.4.0 CH Term v3.4

Constraints

Id Grade Path(s) Description Expression
ch-addr-1 warning 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-codedString' and (value.code = 'CH' or value.code = 'CHE')).empty() or 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 Address

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Address C 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Constraints: ch-addr-2
Address.line
Address.line.Slices for extension 0..* Extension Extension
Slice: Ordered, Open by value:url, value:value
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.line.Slices for extension.extension:addressLine1 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Address.line.Slices for extension.extension:addressLine1.Slices for value[x] Content/Rules for all slices
Address.line.Slices for extension.extension:addressLine1.Slices for value[x].value[x]:valueCode 1..1 code Value of extension
Fixed Value: addressLine1 (no extensions allowed)
Address.line.Slices for extension.extension:addressLine2 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Address.line.Slices for extension.extension:addressLine2.Slices for value[x] Content/Rules for all slices
Address.line.Slices for extension.extension:addressLine2.Slices for value[x].value[x]:valueCode 1..1 code Value of extension
Fixed Value: addressLine2 (no extensions allowed)
Address.line.Slices for extension.extension:street 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Address.line.Slices for extension.extension:street.Slices for value[x] Content/Rules for all slices
Address.line.Slices for extension.extension:street.Slices for value[x].value[x]:valueCode 1..1 code Value of extension
Fixed Value: street (no extensions allowed)
Address.line.Slices for extension.extension:streetName 0..1 string street part of the street line, e.g. without house number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
Address.line.Slices for extension.extension:houseNumber 0..1 string houseNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
Address.line.Slices for extension.extension:unitID 0..1 string unitID, dwellingNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
Address.line.Slices for extension.extension:postOfficeBoxText 0..1 (Complex) Postbox addresses need a postbox text and optional postbox number
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Address.line.Slices for extension.extension:postOfficeBoxText.Slices for value[x] Content/Rules for all slices
Address.line.Slices for extension.extension:postOfficeBoxText.Slices for value[x].value[x]:valueCode 1..1 code Value of extension
Fixed Value: postOfficeBoxText (no extensions allowed)
Address.line.Slices for extension.extension:postOfficeBoxNumber 0..1 string Optional postOfficeBoxNumber as a separate part of the postOfficeBoxText
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
Address.city 0..1 string Name of city, town etc.
Address.city.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.city.Slices for extension.extension:bfs 0..1 string Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
Address.district 0..1 string District name (aka county)
Address.postalCode 0..1 string Postal code for area
Address.country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: BFS Verzeichnis der Staaten und Gebiete (preferred)
Address.country.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.country.Slices for extension.extension:countrycode C 0..1 (Complex) ISO Country Alpha-2 or ISO Country Alpha-3 code
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
Constraints: ch-addr-1
Address.country.Slices for extension.extension:countrycode.value[x] 1..1 Coding Value of extension
Binding: BFS Verzeichnis der Staaten und Gebiete (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Address.state Base example eCH-0007 Canton Abbreviation 📦3.4.0 CH Term v3.4
Address.country Base preferred BFS Verzeichnis der Staaten und Gebiete 📦3.4.0 CH Term v3.4
Address.country.extension:countrycode.​value[x] Base extensible BFS Verzeichnis der Staaten und Gebiete 📦3.4.0 CH Term v3.4

Constraints

Id Grade Path(s) Description Expression
ch-addr-1 warning 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-codedString' and (value.code = 'CH' or value.code = 'CHE')).empty() or state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation')
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Address C 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Constraints: ch-addr-2
Address.id 0..1 string Unique id for inter-element referencing
Address.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Address.line This element is included in summaries. 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
Address.line.id 0..1 string xml:id (or equivalent in JSON)
Address.line.Slices for extension 0..* Extension Extension
Slice: Ordered, Open by value:url, value:value

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.line.Slices for extension.extension:addressLine1 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Address.line.Slices for extension.extension:addressLine1.id 0..1 string Unique id for inter-element referencing
Address.line.Slices for extension.extension:addressLine1.extension 0..0 Extension
Slice: Unordered, Open by value:url
Address.line.Slices for extension.extension:addressLine1.url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
Address.line.Slices for extension.extension:addressLine1.Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
Address.line.Slices for extension.extension:addressLine1.Slices for value[x] Content/Rules for all slices
Address.line.Slices for extension.extension:addressLine1.Slices for value[x].value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: addressLine1 (no extensions allowed)
Address.line.Slices for extension.extension:addressLine2 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Address.line.Slices for extension.extension:addressLine2.id 0..1 string Unique id for inter-element referencing
Address.line.Slices for extension.extension:addressLine2.extension 0..0 Extension
Slice: Unordered, Open by value:url
Address.line.Slices for extension.extension:addressLine2.url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
Address.line.Slices for extension.extension:addressLine2.Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
Address.line.Slices for extension.extension:addressLine2.Slices for value[x] Content/Rules for all slices
Address.line.Slices for extension.extension:addressLine2.Slices for value[x].value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: addressLine2 (no extensions allowed)
Address.line.Slices for extension.extension:street 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Address.line.Slices for extension.extension:street.id 0..1 string Unique id for inter-element referencing
Address.line.Slices for extension.extension:street.extension 0..0 Extension
Slice: Unordered, Open by value:url
Address.line.Slices for extension.extension:street.url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
Address.line.Slices for extension.extension:street.Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
Address.line.Slices for extension.extension:street.Slices for value[x] Content/Rules for all slices
Address.line.Slices for extension.extension:street.Slices for value[x].value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: street (no extensions allowed)
Address.line.Slices for extension.extension:streetName 0..1 string street part of the street line, e.g. without house number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
Address.line.Slices for extension.extension:houseNumber 0..1 string houseNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
Address.line.Slices for extension.extension:unitID 0..1 string unitID, dwellingNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
Address.line.Slices for extension.extension:postOfficeBoxText 0..1 (Complex) Postbox addresses need a postbox text and optional postbox number
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Address.line.Slices for extension.extension:postOfficeBoxText.id 0..1 string Unique id for inter-element referencing
Address.line.Slices for extension.extension:postOfficeBoxText.extension 0..0 Extension
Slice: Unordered, Open by value:url
Address.line.Slices for extension.extension:postOfficeBoxText.url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
Address.line.Slices for extension.extension:postOfficeBoxText.Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
Address.line.Slices for extension.extension:postOfficeBoxText.Slices for value[x] Content/Rules for all slices
Address.line.Slices for extension.extension:postOfficeBoxText.Slices for value[x].value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: postOfficeBoxText (no extensions allowed)
Address.line.Slices for extension.extension:postOfficeBoxNumber 0..1 string Optional postOfficeBoxNumber as a separate part of the postOfficeBoxText
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
Address.line.value 0..1 string Primitive value for string
Max Length:1048576
Address.city This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Address.city.id 0..1 string xml:id (or equivalent in JSON)
Address.city.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.city.Slices for extension.extension:bfs 0..1 string Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
Address.city.value 0..1 string Primitive value for string
Max Length:1048576
Address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Address.state This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: eCH-0007 Canton Abbreviation (example): Use these values for a Swiss or Liechtenstein address
Address.postalCode This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Address.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: BFS Verzeichnis der Staaten und Gebiete (preferred)
Address.country.id 0..1 string xml:id (or equivalent in JSON)
Address.country.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.country.Slices for extension.extension:countrycode C 0..1 (Complex) ISO Country Alpha-2 or ISO Country Alpha-3 code
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
Constraints: ch-addr-1
Address.country.Slices for extension.extension:countrycode.id 0..1 string Unique id for inter-element referencing
Address.country.Slices for extension.extension:countrycode.extension 0..0 Extension
Slice: Unordered, Open by value:url
Address.country.Slices for extension.extension:countrycode.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
Address.country.Slices for extension.extension:countrycode.value[x] 1..1 Coding Value of extension
Binding: BFS Verzeichnis der Staaten und Gebiete (extensible)
Address.country.value 0..1 string Primitive value for string
Max Length:1048576
Address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco 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.line.extension:addressLine1.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.4.0 CH Term v3.4
Address.line.extension:addressLine2.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.4.0 CH Term v3.4
Address.line.extension:street.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.4.0 CH Term v3.4
Address.line.extension:postOfficeBoxText.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.4.0 CH Term v3.4
Address.state Base example eCH-0007 Canton Abbreviation 📦3.4.0 CH Term v3.4
Address.country Base preferred BFS Verzeichnis der Staaten und Gebiete 📦3.4.0 CH Term v3.4
Address.country.extension:countrycode.​value[x] Base extensible BFS Verzeichnis der Staaten und Gebiete 📦3.4.0 CH Term v3.4

Constraints

Id Grade Path(s) Description Expression
ch-addr-1 warning 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-codedString' and (value.code = 'CH' or value.code = 'CHE')).empty() or 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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Address C 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Constraints: ch-addr-2
Address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Address.city This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Address.city.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.city.Slices for extension.extension:bfs 0..1 string Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
Address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Address.state This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: eCH-0007 Canton Abbreviation (example): Use these values for a Swiss or Liechtenstein address
Address.postalCode This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Address.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: BFS Verzeichnis der Staaten und Gebiete (preferred)
Address.country.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.country.Slices for extension.extension:countrycode C 0..1 (Complex) ISO Country Alpha-2 or ISO Country Alpha-3 code
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
Constraints: ch-addr-1
Address.country.Slices for extension.extension:countrycode.extension 0..0 Extension
Slice: Unordered, Open by value:url
Address.country.Slices for extension.extension:countrycode.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
Address.country.Slices for extension.extension:countrycode.value[x] 1..1 Coding Value of extension
Binding: BFS Verzeichnis der Staaten und Gebiete (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Address.use Base required AddressUse 📍4.0.1 FHIR Std.
Address.state Base example eCH-0007 Canton Abbreviation 📦3.4.0 CH Term v3.4
Address.country Base preferred BFS Verzeichnis der Staaten und Gebiete 📦3.4.0 CH Term v3.4
Address.country.extension:countrycode.​value[x] Base extensible BFS Verzeichnis der Staaten und Gebiete 📦3.4.0 CH Term v3.4

Constraints

Id Grade Path(s) Description Expression
ch-addr-1 warning 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-codedString' and (value.code = 'CH' or value.code = 'CHE')).empty() or 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()

Differential View

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Address C 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Constraints: ch-addr-2
Address.line
Address.line.Slices for extension 0..* Extension Extension
Slice: Ordered, Open by value:url, value:value
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.line.Slices for extension.extension:addressLine1 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Address.line.Slices for extension.extension:addressLine1.Slices for value[x] Content/Rules for all slices
Address.line.Slices for extension.extension:addressLine1.Slices for value[x].value[x]:valueCode 1..1 code Value of extension
Fixed Value: addressLine1 (no extensions allowed)
Address.line.Slices for extension.extension:addressLine2 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Address.line.Slices for extension.extension:addressLine2.Slices for value[x] Content/Rules for all slices
Address.line.Slices for extension.extension:addressLine2.Slices for value[x].value[x]:valueCode 1..1 code Value of extension
Fixed Value: addressLine2 (no extensions allowed)
Address.line.Slices for extension.extension:street 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Address.line.Slices for extension.extension:street.Slices for value[x] Content/Rules for all slices
Address.line.Slices for extension.extension:street.Slices for value[x].value[x]:valueCode 1..1 code Value of extension
Fixed Value: street (no extensions allowed)
Address.line.Slices for extension.extension:streetName 0..1 string street part of the street line, e.g. without house number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
Address.line.Slices for extension.extension:houseNumber 0..1 string houseNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
Address.line.Slices for extension.extension:unitID 0..1 string unitID, dwellingNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
Address.line.Slices for extension.extension:postOfficeBoxText 0..1 (Complex) Postbox addresses need a postbox text and optional postbox number
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Address.line.Slices for extension.extension:postOfficeBoxText.Slices for value[x] Content/Rules for all slices
Address.line.Slices for extension.extension:postOfficeBoxText.Slices for value[x].value[x]:valueCode 1..1 code Value of extension
Fixed Value: postOfficeBoxText (no extensions allowed)
Address.line.Slices for extension.extension:postOfficeBoxNumber 0..1 string Optional postOfficeBoxNumber as a separate part of the postOfficeBoxText
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
Address.city 0..1 string Name of city, town etc.
Address.city.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.city.Slices for extension.extension:bfs 0..1 string Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
Address.district 0..1 string District name (aka county)
Address.state 0..1 string Sub-unit of country (abbreviations ok)
Binding: eCH-0007 Canton Abbreviation (example): Use these values for a Swiss or Liechtenstein address
Address.postalCode 0..1 string Postal code for area
Address.country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: BFS Verzeichnis der Staaten und Gebiete (preferred)
Address.country.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.country.Slices for extension.extension:countrycode C 0..1 (Complex) ISO Country Alpha-2 or ISO Country Alpha-3 code
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
Constraints: ch-addr-1
Address.country.Slices for extension.extension:countrycode.value[x] 1..1 Coding Value of extension
Binding: BFS Verzeichnis der Staaten und Gebiete (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Address.state Base example eCH-0007 Canton Abbreviation 📦3.4.0 CH Term v3.4
Address.country Base preferred BFS Verzeichnis der Staaten und Gebiete 📦3.4.0 CH Term v3.4
Address.country.extension:countrycode.​value[x] Base extensible BFS Verzeichnis der Staaten und Gebiete 📦3.4.0 CH Term v3.4

Constraints

Id Grade Path(s) Description Expression
ch-addr-1 warning 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-codedString' and (value.code = 'CH' or value.code = 'CHE')).empty() or state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation')

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Address C 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Constraints: ch-addr-2
Address.id 0..1 string Unique id for inter-element referencing
Address.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Address.line This element is included in summaries. 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
Address.line.id 0..1 string xml:id (or equivalent in JSON)
Address.line.Slices for extension 0..* Extension Extension
Slice: Ordered, Open by value:url, value:value

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.line.Slices for extension.extension:addressLine1 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Address.line.Slices for extension.extension:addressLine1.id 0..1 string Unique id for inter-element referencing
Address.line.Slices for extension.extension:addressLine1.extension 0..0 Extension
Slice: Unordered, Open by value:url
Address.line.Slices for extension.extension:addressLine1.url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
Address.line.Slices for extension.extension:addressLine1.Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
Address.line.Slices for extension.extension:addressLine1.Slices for value[x] Content/Rules for all slices
Address.line.Slices for extension.extension:addressLine1.Slices for value[x].value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: addressLine1 (no extensions allowed)
Address.line.Slices for extension.extension:addressLine2 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Address.line.Slices for extension.extension:addressLine2.id 0..1 string Unique id for inter-element referencing
Address.line.Slices for extension.extension:addressLine2.extension 0..0 Extension
Slice: Unordered, Open by value:url
Address.line.Slices for extension.extension:addressLine2.url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
Address.line.Slices for extension.extension:addressLine2.Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
Address.line.Slices for extension.extension:addressLine2.Slices for value[x] Content/Rules for all slices
Address.line.Slices for extension.extension:addressLine2.Slices for value[x].value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: addressLine2 (no extensions allowed)
Address.line.Slices for extension.extension:street 0..1 (Complex) Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Address.line.Slices for extension.extension:street.id 0..1 string Unique id for inter-element referencing
Address.line.Slices for extension.extension:street.extension 0..0 Extension
Slice: Unordered, Open by value:url
Address.line.Slices for extension.extension:street.url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
Address.line.Slices for extension.extension:street.Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
Address.line.Slices for extension.extension:street.Slices for value[x] Content/Rules for all slices
Address.line.Slices for extension.extension:street.Slices for value[x].value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: street (no extensions allowed)
Address.line.Slices for extension.extension:streetName 0..1 string street part of the street line, e.g. without house number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
Address.line.Slices for extension.extension:houseNumber 0..1 string houseNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
Address.line.Slices for extension.extension:unitID 0..1 string unitID, dwellingNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
Address.line.Slices for extension.extension:postOfficeBoxText 0..1 (Complex) Postbox addresses need a postbox text and optional postbox number
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Address.line.Slices for extension.extension:postOfficeBoxText.id 0..1 string Unique id for inter-element referencing
Address.line.Slices for extension.extension:postOfficeBoxText.extension 0..0 Extension
Slice: Unordered, Open by value:url
Address.line.Slices for extension.extension:postOfficeBoxText.url 1..1 uri "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
Address.line.Slices for extension.extension:postOfficeBoxText.Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
Address.line.Slices for extension.extension:postOfficeBoxText.Slices for value[x] Content/Rules for all slices
Address.line.Slices for extension.extension:postOfficeBoxText.Slices for value[x].value[x]:valueCode 1..1 code Value of extension
Binding: eCH-010 Address Line Type (extensible)
Fixed Value: postOfficeBoxText (no extensions allowed)
Address.line.Slices for extension.extension:postOfficeBoxNumber 0..1 string Optional postOfficeBoxNumber as a separate part of the postOfficeBoxText
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
Address.line.value 0..1 string Primitive value for string
Max Length:1048576
Address.city This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Address.city.id 0..1 string xml:id (or equivalent in JSON)
Address.city.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.city.Slices for extension.extension:bfs 0..1 string Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
Address.city.value 0..1 string Primitive value for string
Max Length:1048576
Address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Address.state This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: eCH-0007 Canton Abbreviation (example): Use these values for a Swiss or Liechtenstein address
Address.postalCode This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Address.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: BFS Verzeichnis der Staaten und Gebiete (preferred)
Address.country.id 0..1 string xml:id (or equivalent in JSON)
Address.country.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Address.country.Slices for extension.extension:countrycode C 0..1 (Complex) ISO Country Alpha-2 or ISO Country Alpha-3 code
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
Constraints: ch-addr-1
Address.country.Slices for extension.extension:countrycode.id 0..1 string Unique id for inter-element referencing
Address.country.Slices for extension.extension:countrycode.extension 0..0 Extension
Slice: Unordered, Open by value:url
Address.country.Slices for extension.extension:countrycode.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
Address.country.Slices for extension.extension:countrycode.value[x] 1..1 Coding Value of extension
Binding: BFS Verzeichnis der Staaten und Gebiete (extensible)
Address.country.value 0..1 string Primitive value for string
Max Length:1048576
Address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco 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.line.extension:addressLine1.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.4.0 CH Term v3.4
Address.line.extension:addressLine2.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.4.0 CH Term v3.4
Address.line.extension:street.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.4.0 CH Term v3.4
Address.line.extension:postOfficeBoxText.​value[x]:valueCode Base extensible eCH-010 Address Line Type 📦3.4.0 CH Term v3.4
Address.state Base example eCH-0007 Canton Abbreviation 📦3.4.0 CH Term v3.4
Address.country Base preferred BFS Verzeichnis der Staaten und Gebiete 📦3.4.0 CH Term v3.4
Address.country.extension:countrycode.​value[x] Base extensible BFS Verzeichnis der Staaten und Gebiete 📦3.4.0 CH Term v3.4

Constraints

Id Grade Path(s) Description Expression
ch-addr-1 warning 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-codedString' and (value.code = 'CH' or value.code = 'CHE')).empty() or 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()

 

Other representations of profile: CSV, Excel, Schematron