CH.FHIR.IG.CH-CORE\Address for Place of Birth - Definitions

CH Core (R4)
3.0.0 - STU3 Switzerland flag

This page is part of the CH Core (R4) (v3.0.0: STU 3) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Data Type Profile: CHCoreAddressEch11PlaceOfBirth - Detailed Descriptions

Active as of 2018-11-21

Definitions for the ch-core-address-ech-11-placeofbirth data type profile.

Guidance on how to interpret the contents of this table can be found here.

1. Address
2. Address.use
Control	0..01
3. Address.type
Control	0..01
4. Address.text
Control	0..01
5. Address.line
Control	0..0*
6. Address.city
Definition	optional if country is not Switzerland The name of the city, town, suburb, village or other community or delivery center.
Alternate Names	Municpality
7. Address.city.extension:bfs
SliceName	bfs
8. Address.district
Control	0..01
Alternate Names	County
9. Address.state
Definition	Canton 2 letter abbreviation Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).
Alternate Names	Province, Territory
10. Address.postalCode
Control	0..01
Alternate Names	Zip
11. Address.country
Definition	Country if place of Birth is not Switzerland Country - a nation as commonly understood or generally accepted.
12. Address.period
Control	0..01

Guidance on how to interpret the contents of this table can be found here.

1. Address
Definition	An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
Control	0..* This element is affected by the following invariants: ele-1
Comments	Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. Address.use
Definition	The purpose of this address.
Control	0..01
Binding	The codes SHALL be taken from AddressUse The use of an address.
Type	code
Is Modifier	true
Summary	true
Requirements	Allows an appropriate address to be chosen from a list of many.
Comments	Applications can assume that an address is current unless it explicitly says that it is temporary or old.
Example	General:home
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. Address.type
Definition	Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
Control	0..01
Binding	The codes SHALL be taken from AddressType The type of an address (physical / postal).
Type	code
Summary	true
Comments	The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).
Example	General:both
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. Address.text
Definition	Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.
Control	0..01
Type	string
Summary	true
Requirements	A renderable, unencoded form.
Comments	Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
Example	General:137 Nowhere Street, Erewhon 9132
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Address.line
Definition	This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
Control	0..0*
Type	string
Summary	true
Example	General:137 Nowhere Street
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Address.city
Definition	optional if country is not Switzerland The name of the city, town, suburb, village or other community or delivery center.
Control	0..1
Type	string
Summary	true
Alternate Names	Municpality
Example	General:Erewhon
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Address.city.extension:bfs
SliceName	bfs
Definition	Extension for eCH-0011 - bfs number (ministry of statistics number)
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(ECH007MunicipalityId) (Extension Type: string)
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
8. Address.district
Definition	The name of the administrative area (county).
Control	0..01
Type	string
Summary	true
Alternate Names	County
Comments	District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
Example	General:Madison
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. Address.state
Definition	Canton 2 letter abbreviation Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).
Control	0..1
Type	string
Summary	true
Alternate Names	Province, Territory
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. Address.postalCode
Definition	A postal code designating a region defined by the postal service.
Control	0..01
Type	string
Summary	true
Alternate Names	Zip
Example	General:9132
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. Address.country
Definition	Country if place of Birth is not Switzerland Country - a nation as commonly understood or generally accepted.
Control	0..1
Type	string
Summary	true
Comments	ISO 3166 3 letter codes can be used in place of a human readable country name.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. Address.country.extension:countrycode
SliceName	countrycode
Definition	The content of the country code element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, if the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(SC-coding) (Extension Type: Coding)
Invariants	Defined on this element ch-addr-1: 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'))) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
13. Address.period
Definition	Time period when address was/is in use.
Control	0..01
Type	Period
Summary	true
Requirements	Allows addresses to be placed in historical context.
Example	General:<valuePeriod xmlns="http://hl7.org/fhir"> <start value="2010-03-23"/> <end value="2010-07-01"/> </valuePeriod>
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here.

1. Address
Definition	An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
Control	0..* This element is affected by the following invariants: ele-1
Comments	Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
2. Address.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
3. Address.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Address.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
4. Address.use
Definition	The purpose of this address.
Control	0..0
Binding	The codes SHALL be taken from AddressUse The use of an address
Type	code
Is Modifier	true
Summary	true
Requirements	Allows an appropriate address to be chosen from a list of many.
Comments	Applications can assume that an address is current unless it explicitly says that it is temporary or old.
Example	General:home
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Address.type
Definition	Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
Control	0..0
Binding	The codes SHALL be taken from AddressType The type of an address (physical / postal)
Type	code
Summary	true
Comments	The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).
Example	General:both
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Address.text
Definition	Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.
Control	0..0
Type	string
Summary	true
Requirements	A renderable, unencoded form.
Comments	Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
Example	General:137 Nowhere Street, Erewhon 9132
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Address.line
Definition	This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
Control	0..0
Type	string
Summary	true
Example	General:137 Nowhere Street
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. Address.city
Definition	optional if country is not Switzerland
Control	0..1
Type	string
Summary	true
Alternate Names	Municpality
Example	General:Erewhon
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. Address.city.id
Definition	unique id for the element within a resource (for internal references)
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
10. Address.city.extension
Definition	An Extension
Control	0..*
Type	Extension
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Address.city.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
11. Address.city.extension:bfs
SliceName	bfs
Definition	Extension for eCH-0011 - bfs number (ministry of statistics number)
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(ECH007MunicipalityId) (Extension Type: string)
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
12. Address.city.value
Definition	The actual value
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
Max Length	1048576
13. Address.district
Definition	The name of the administrative area (county).
Control	0..0
Type	string
Summary	true
Alternate Names	County
Comments	District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
Example	General:Madison
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Address.state
Definition	Canton 2 letter abbreviation
Control	0..1
Type	string
Summary	true
Alternate Names	Province, Territory
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. Address.postalCode
Definition	A postal code designating a region defined by the postal service.
Control	0..0
Type	string
Summary	true
Alternate Names	Zip
Example	General:9132
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. Address.country
Definition	Country if place of Birth is not Switzerland
Control	0..1
Type	string
Summary	true
Comments	ISO 3166 3 letter codes can be used in place of a human readable country name.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. Address.country.id
Definition	unique id for the element within a resource (for internal references)
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
18. Address.country.extension
Definition	An Extension
Control	0..*
Type	Extension
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Address.country.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
19. Address.country.extension:countrycode
SliceName	countrycode
Definition	The content of the country code element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, if the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(SC-coding) (Extension Type: Coding)
Invariants	Defined on this element ch-addr-1: 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'))) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
20. Address.country.value
Definition	The actual value
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
Max Length	1048576
21. Address.period
Definition	Time period when address was/is in use.
Control	0..0
Type	Period
Summary	true
Requirements	Allows addresses to be placed in historical context.
Example	General:<valuePeriod xmlns="http://hl7.org/fhir"> <start value="2010-03-23"/> <end value="2010-07-01"/> </valuePeriod>
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

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