Address for Place of Birth - CH Core (R4) v4.0.1

CH Core (R4)
4.0.1 - trial-use Switzerland flag

This page is part of the CH Core (R4) (v4.0.1: STU 4) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Data Type Profile: Address for Place of Birth

Official URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-address-ech-11-placeofbirth				Version: 4.0.1
Active as of 2023-12-28				Computable Name: CHCoreAddressEch11PlaceOfBirth
Copyright/Legal: CC0-1.0

PlaceOfBirth for ech-11

Usage:

Use this DataType Constraint: Place of Birth according to eCH-0011

Formal Views of Profile Content

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

This structure is derived from CHCoreAddress

Name	Card.	Type	Description & Constraints
Address	0..*	CHCoreAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
use	0..0
type	0..0
text	0..0
line	0..0
city	0..1	string	Place of Birth (municipality)
extension:bfs	0..1	ECH007MunicipalityId	Extension
district	0..0
state	0..1	string	Canton
postalCode	0..0
country	0..1	string	Country if place of Birth is not Switzerland
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)
city	Σ	0..1	string	Place of Birth (municipality) Example General: Erewhon
bfs		0..1	string	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
state	Σ	0..1	string	Canton Binding: eCH-0007 Canton Abbreviation incl. FL (Fürstentum Liechtenstein) (example): Use these values for a Swiss or Liechtenstein address
country	Σ	0..1	string	Country if place of Birth is not Switzerland
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.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Address.line.extension:addressLine1.value[x]:valueCode	extensible	Fixed Value: addressLine1
Address.line.extension:addressLine2.value[x]:valueCode	extensible	Fixed Value: addressLine2
Address.line.extension:street.value[x]:valueCode	extensible	Fixed Value: street
Address.line.extension:postOfficeBoxText.value[x]:valueCode	extensible	Fixed Value: postOfficeBoxText
Address.state	example	ECH007CantonFLAbbreviation (a valid code from eCH-0007 Canton Abbreviation incl. FL (Fürstentum Liechtenstein))

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)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
city	Σ	0..1	string	Place of Birth (municipality) 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
state	Σ	0..1	string	Canton Binding: eCH-0007 Canton Abbreviation incl. FL (Fürstentum Liechtenstein) (example): Use these values for a Swiss or Liechtenstein address
country	Σ	0..1	string	Country if place of Birth is not Switzerland
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.
value		0..1	string	Primitive value for string Max Length: 1048576
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Address.line.extension:addressLine1.value[x]:valueCode	extensible	Fixed Value: addressLine1
Address.line.extension:addressLine2.value[x]:valueCode	extensible	Fixed Value: addressLine2
Address.line.extension:street.value[x]:valueCode	extensible	Fixed Value: street
Address.line.extension:postOfficeBoxText.value[x]:valueCode	extensible	Fixed Value: postOfficeBoxText
Address.state	example	ECH007CantonFLAbbreviation (a valid code from eCH-0007 Canton Abbreviation incl. FL (Fürstentum Liechtenstein))

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()

Differential View

This structure is derived from CHCoreAddress

Name	Card.	Type	Description & Constraints
Address	0..*	CHCoreAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
use	0..0
type	0..0
text	0..0
line	0..0
city	0..1	string	Place of Birth (municipality)
extension:bfs	0..1	ECH007MunicipalityId	Extension
district	0..0
state	0..1	string	Canton
postalCode	0..0
country	0..1	string	Country if place of Birth is not Switzerland
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)
city	Σ	0..1	string	Place of Birth (municipality) Example General: Erewhon
bfs		0..1	string	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
state	Σ	0..1	string	Canton Binding: eCH-0007 Canton Abbreviation incl. FL (Fürstentum Liechtenstein) (example): Use these values for a Swiss or Liechtenstein address
country	Σ	0..1	string	Country if place of Birth is not Switzerland
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.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Address.line.extension:addressLine1.value[x]:valueCode	extensible	Fixed Value: addressLine1
Address.line.extension:addressLine2.value[x]:valueCode	extensible	Fixed Value: addressLine2
Address.line.extension:street.value[x]:valueCode	extensible	Fixed Value: street
Address.line.extension:postOfficeBoxText.value[x]:valueCode	extensible	Fixed Value: postOfficeBoxText
Address.state	example	ECH007CantonFLAbbreviation (a valid code from eCH-0007 Canton Abbreviation incl. FL (Fürstentum Liechtenstein))

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)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
city	Σ	0..1	string	Place of Birth (municipality) 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
state	Σ	0..1	string	Canton Binding: eCH-0007 Canton Abbreviation incl. FL (Fürstentum Liechtenstein) (example): Use these values for a Swiss or Liechtenstein address
country	Σ	0..1	string	Country if place of Birth is not Switzerland
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.
value		0..1	string	Primitive value for string Max Length: 1048576
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Address.line.extension:addressLine1.value[x]:valueCode	extensible	Fixed Value: addressLine1
Address.line.extension:addressLine2.value[x]:valueCode	extensible	Fixed Value: addressLine2
Address.line.extension:street.value[x]:valueCode	extensible	Fixed Value: street
Address.line.extension:postOfficeBoxText.value[x]:valueCode	extensible	Fixed Value: postOfficeBoxText
Address.state	example	ECH007CantonFLAbbreviation (a valid code from eCH-0007 Canton Abbreviation incl. FL (Fürstentum Liechtenstein))

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

Prohibited: 7 elements

Other representations of profile: CSV, Excel, Schematron

IG © 2020+ HL7 Switzerland. Package ch.fhir.ig.ch-core#4.0.1 based on FHIR 4.0.1. Generated 2023-12-28
Links: Table of Contents | QA Report | Propose a change