CH Core (R4)
1.1.0 - CI build

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

StructureDefinition: CHCoreAddress

address incorporating eCH-0010 postal address extensions

The official URL for this profile is:

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

Formal Views of Profile Content

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

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... line 0..*stringStreet name, number, direction & P.O. Box etc.
.... extension 0..*ExtensionExtension
Slice: Ordered, Open by value:url, value:value
..... ch-ext-ech-10-linetype 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
...... valueCode 1..1codeValue of extension
Fixed Value: addressLine1
..... ch-ext-ech-10-linetype 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
...... valueCode 1..1codeValue of extension
Fixed Value: addressLine2
..... ch-ext-ech-10-linetype 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
...... valueCode 1..1codeValue of extension
Fixed Value: street
..... iso21090-ADXP-houseNumber 0..1stringhouseNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... iso21090-ADXP-unitID 0..1stringunitID, dwellingNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
..... ch-ext-ech-10-linetype 0..1codePostbox addresses need an postbox text and optional postbox number
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
...... valueCode 1..1codeValue of extension
Fixed Value: postOfficeBoxText
..... iso21090-ADXP-postBox 0..1stringOptional postOfficeBoxNumber as a separate part of the postOfficeBoxText
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
... city Σ0..1stringName of city, town etc.
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ch-ext-ech-7-municipalityid 0..1stringExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
... district Σ0..1stringDistrict name (aka county)
... postalCode 0..1stringPostal code for area
... country 0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... iso21090-SC-coding I0..1CodingISO 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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!ΣI0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General: home
... text ΣI0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line ΣI0..*stringStreet 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..1stringxml:id (or equivalent in JSON)
.... extension I0..*ExtensionExtension
Slice: Ordered, Open by value:url, value:value
..... ch-ext-ech-10-linetype I0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..0
...... url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
...... value[x] I0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCode I1..1codeValue of extension
Binding: eCH-010 Address Line Type (required)
Fixed Value: addressLine1
..... ch-ext-ech-10-linetype I0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..0
...... url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
...... value[x] I0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCode I1..1codeValue of extension
Binding: eCH-010 Address Line Type (required)
Fixed Value: addressLine2
..... ch-ext-ech-10-linetype I0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..0
...... url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
...... value[x] I0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCode I1..1codeValue of extension
Binding: eCH-010 Address Line Type (required)
Fixed Value: street
..... iso21090-ADXP-houseNumber I0..1stringhouseNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... iso21090-ADXP-unitID I0..1stringunitID, dwellingNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
..... ch-ext-ech-10-linetype I0..1codePostbox addresses need an postbox text and optional postbox number
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..0
...... url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
...... value[x] I0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCode I1..1codeValue of extension
Binding: eCH-010 Address Line Type (required)
Fixed Value: postOfficeBoxText
..... iso21090-ADXP-postBox I0..1stringOptional postOfficeBoxNumber as a separate part of the postOfficeBoxText
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... city ΣI0..1stringName of city, town etc.
Example General: Erewhon
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ch-ext-ech-7-municipalityid I0..1stringExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... district ΣI0..1stringDistrict name (aka county)
Example General: Madison
... state ΣI0..1stringSub-unit of country (abbreviations ok)
... postalCode ΣI0..1stringPostal code for area
Example General: 9132
... country ΣI0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... iso21090-SC-coding I0..1CodingISO 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..1stringPrimitive value for string
Max Length: 1048576
... period ΣI0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Differential View

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... line 0..*stringStreet name, number, direction & P.O. Box etc.
.... extension 0..*ExtensionExtension
Slice: Ordered, Open by value:url, value:value
..... ch-ext-ech-10-linetype 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
...... valueCode 1..1codeValue of extension
Fixed Value: addressLine1
..... ch-ext-ech-10-linetype 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
...... valueCode 1..1codeValue of extension
Fixed Value: addressLine2
..... ch-ext-ech-10-linetype 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
...... valueCode 1..1codeValue of extension
Fixed Value: street
..... iso21090-ADXP-houseNumber 0..1stringhouseNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... iso21090-ADXP-unitID 0..1stringunitID, dwellingNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
..... ch-ext-ech-10-linetype 0..1codePostbox addresses need an postbox text and optional postbox number
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
...... valueCode 1..1codeValue of extension
Fixed Value: postOfficeBoxText
..... iso21090-ADXP-postBox 0..1stringOptional postOfficeBoxNumber as a separate part of the postOfficeBoxText
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
... city Σ0..1stringName of city, town etc.
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ch-ext-ech-7-municipalityid 0..1stringExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
... district Σ0..1stringDistrict name (aka county)
... postalCode 0..1stringPostal code for area
... country 0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... iso21090-SC-coding I0..1CodingISO 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

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!ΣI0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General: home
... text ΣI0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line ΣI0..*stringStreet 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..1stringxml:id (or equivalent in JSON)
.... extension I0..*ExtensionExtension
Slice: Ordered, Open by value:url, value:value
..... ch-ext-ech-10-linetype I0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..0
...... url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
...... value[x] I0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCode I1..1codeValue of extension
Binding: eCH-010 Address Line Type (required)
Fixed Value: addressLine1
..... ch-ext-ech-10-linetype I0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..0
...... url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
...... value[x] I0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCode I1..1codeValue of extension
Binding: eCH-010 Address Line Type (required)
Fixed Value: addressLine2
..... ch-ext-ech-10-linetype I0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..0
...... url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
...... value[x] I0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCode I1..1codeValue of extension
Binding: eCH-010 Address Line Type (required)
Fixed Value: street
..... iso21090-ADXP-houseNumber I0..1stringhouseNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... iso21090-ADXP-unitID I0..1stringunitID, dwellingNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
..... ch-ext-ech-10-linetype I0..1codePostbox addresses need an postbox text and optional postbox number
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..0
...... url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
...... value[x] I0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCode I1..1codeValue of extension
Binding: eCH-010 Address Line Type (required)
Fixed Value: postOfficeBoxText
..... iso21090-ADXP-postBox I0..1stringOptional postOfficeBoxNumber as a separate part of the postOfficeBoxText
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... city ΣI0..1stringName of city, town etc.
Example General: Erewhon
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ch-ext-ech-7-municipalityid I0..1stringExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... district ΣI0..1stringDistrict name (aka county)
Example General: Madison
... state ΣI0..1stringSub-unit of country (abbreviations ok)
... postalCode ΣI0..1stringPostal code for area
Example General: 9132
... country ΣI0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... iso21090-SC-coding I0..1CodingISO 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..1stringPrimitive value for string
Max Length: 1048576
... period ΣI0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet / Code
Address.userequiredAddressUse
Address.typerequiredAddressType
Address.line.extension:addressLine1.value[x]:valueCoderequiredFixed Value: addressLine1
Address.line.extension:addressLine2.value[x]:valueCoderequiredFixed Value: addressLine2
Address.line.extension:street.value[x]:valueCoderequiredFixed Value: street
Address.line.extension:postOfficeBoxText.value[x]:valueCoderequiredFixed Value: postOfficeBoxText

Constraints

Constraints

IdPathDetailsRequirements
ele-1AddressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Address.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Address.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.lineAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.line.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Address.line.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Address.line.extension:addressLine1All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Address.line.extension:addressLine1Must have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Address.line.extension:addressLine1.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.line.extension:addressLine1.value[x]:valueCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.line.extension:addressLine2All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Address.line.extension:addressLine2Must have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Address.line.extension:addressLine2.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.line.extension:addressLine2.value[x]:valueCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.line.extension:streetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Address.line.extension:streetMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Address.line.extension:street.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.line.extension:street.value[x]:valueCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.line.extension:houseNumberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Address.line.extension:houseNumberMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Address.line.extension:unitIDAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Address.line.extension:unitIDMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Address.line.extension:postOfficeBoxTextAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Address.line.extension:postOfficeBoxTextMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Address.line.extension:postOfficeBoxText.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.line.extension:postOfficeBoxText.value[x]:valueCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.line.extension:postOfficeBoxNumberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Address.line.extension:postOfficeBoxNumberMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Address.cityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.city.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Address.city.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Address.city.extension:bfsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Address.city.extension:bfsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Address.districtAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.stateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.postalCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.countryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Address.country.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Address.country.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Address.country.extension:countrycodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Address.country.extension:countrycodeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ch-addr-1Address.country.extension:countrycodeISO 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'))
ele-1Address.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())