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 - Detailed Descriptions

Definitions for the ch-core-address Profile.

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.

Control0..* 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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
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.

Control0..1
Typestring
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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

InvariantsDefined 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())
SlicingThis 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.

Control0..1
BindingThe use of an address.
The codes SHALL be taken from AddressUse
Typecode
Is Modifiertrue
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
InvariantsDefined 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.

Control0..1
BindingThe type of an address (physical / postal).
The codes SHALL be taken from AddressType
Typecode
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
InvariantsDefined 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.

Control0..1
Typestring
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
InvariantsDefined 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.

Control0..*
Typestring
Example
General:137 Nowhere Street
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. Address.line.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typestring
9. Address.line.extension
Definition

An Extension

Control0..*
TypeExtension
InvariantsDefined 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())
SlicingThis element introduces a set of slices on Address.line.extension. The slices are ordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • ,
  • value @ value
10. Address.line.extension:addressLine1
SliceNameaddressLine1
Definition

eCH-0010: Extension to define line types for an address

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(ECH0010AddressLineType) (Extension Type: code)
InvariantsDefined 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())
11. Address.line.extension:addressLine1.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
12. Address.line.extension:addressLine1.extension
Definition

An Extension

Control0..0
TypeExtension
InvariantsDefined 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())
SlicingThis element introduces a set of slices on Address.line.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
13. Address.line.extension:addressLine1.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
14. Address.line.extension:addressLine1.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typecode
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Address.line.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
15. Address.line.extension:addressLine1.value[x]:valueCode
SliceNamevalueCode
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
BindingA set of codes advising a system or user which name in a set of names to select for a given purpose.
The codes SHALL be taken from eCH-010 Address Line Type
Typecode
[x] NoteSee Choice of Data Types for further information about how to use [x]
Fixed ValueaddressLine1
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. Address.line.extension:addressLine2
SliceNameaddressLine2
Definition

eCH-0010: Extension to define line types for an address

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(ECH0010AddressLineType) (Extension Type: code)
InvariantsDefined 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())
17. Address.line.extension:addressLine2.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
18. Address.line.extension:addressLine2.extension
Definition

An Extension

Control0..0
TypeExtension
InvariantsDefined 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())
SlicingThis element introduces a set of slices on Address.line.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
19. Address.line.extension:addressLine2.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
20. Address.line.extension:addressLine2.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typecode
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Address.line.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
21. Address.line.extension:addressLine2.value[x]:valueCode
SliceNamevalueCode
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
BindingA set of codes advising a system or user which name in a set of names to select for a given purpose.
The codes SHALL be taken from eCH-010 Address Line Type
Typecode
[x] NoteSee Choice of Data Types for further information about how to use [x]
Fixed ValueaddressLine2
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Address.line.extension:street
SliceNamestreet
Definition

eCH-0010: Extension to define line types for an address

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(ECH0010AddressLineType) (Extension Type: code)
InvariantsDefined 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())
23. Address.line.extension:street.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
24. Address.line.extension:street.extension
Definition

An Extension

Control0..0
TypeExtension
InvariantsDefined 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())
SlicingThis element introduces a set of slices on Address.line.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
25. Address.line.extension:street.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
26. Address.line.extension:street.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typecode
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Address.line.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
27. Address.line.extension:street.value[x]:valueCode
SliceNamevalueCode
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
BindingA set of codes advising a system or user which name in a set of names to select for a given purpose.
The codes SHALL be taken from eCH-010 Address Line Type
Typecode
[x] NoteSee Choice of Data Types for further information about how to use [x]
Fixed Valuestreet
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. Address.line.extension:houseNumber
SliceNamehouseNumber
Definition

The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(ADXP-houseNumber) (Extension Type: string)
InvariantsDefined 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())
29. Address.line.extension:unitID
SliceNameunitID
Definition

The number or name of a specific unit contained within a building or complex, as assigned by that building or complex.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(ADXP-unitID) (Extension Type: string)
InvariantsDefined 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())
30. Address.line.extension:postOfficeBoxText
SliceNamepostOfficeBoxText
Definition

eCH-0010: Extension to define line types for an address

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(ECH0010AddressLineType) (Extension Type: code)
InvariantsDefined 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())
31. Address.line.extension:postOfficeBoxText.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
32. Address.line.extension:postOfficeBoxText.extension
Definition

An Extension

Control0..0
TypeExtension
InvariantsDefined 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())
SlicingThis element introduces a set of slices on Address.line.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
33. Address.line.extension:postOfficeBoxText.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
34. Address.line.extension:postOfficeBoxText.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typecode
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Address.line.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
35. Address.line.extension:postOfficeBoxText.value[x]:valueCode
SliceNamevalueCode
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
BindingA set of codes advising a system or user which name in a set of names to select for a given purpose.
The codes SHALL be taken from eCH-010 Address Line Type
Typecode
[x] NoteSee Choice of Data Types for further information about how to use [x]
Fixed ValuepostOfficeBoxText
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. Address.line.extension:postOfficeBoxNumber
SliceNamepostOfficeBoxNumber
Definition

A numbered box located in a post station.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(ADXP-postBox) (Extension Type: string)
InvariantsDefined 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())
37. Address.line.value
Definition

The actual value

Control0..1
Typestring
Max Length1048576
38. Address.city
Definition

The name of the city, town, suburb, village or other community or delivery center.

Control0..1
Typestring
Alternate NamesMunicpality
Example
General:Erewhon
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. Address.city.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typestring
40. Address.city.extension
Definition

An Extension

Control0..*
TypeExtension
InvariantsDefined 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())
SlicingThis 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
41. Address.city.extension:bfs
SliceNamebfs
Definition

Extension for eCH-0011 - bfs number (ministry of statistics number)

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(ECH007MunicipalityId) (Extension Type: string)
InvariantsDefined 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())
42. Address.city.value
Definition

The actual value

Control0..1
Typestring
Max Length1048576
43. Address.district
Definition

The name of the administrative area (county).

Control0..1
Typestring
Alternate NamesCounty
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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. Address.state
Definition

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

Control0..1
Typestring
Alternate NamesProvince, Territory
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. Address.postalCode
Definition

A postal code designating a region defined by the postal service.

Control0..1
Typestring
Alternate NamesZip
Example
General:9132
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. Address.country
Definition

Country - a nation as commonly understood or generally accepted.

Control0..1
Typestring
Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
47. Address.country.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typestring
48. Address.country.extension
Definition

An Extension

Control0..*
TypeExtension
InvariantsDefined 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())
SlicingThis 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
49. Address.country.extension:countrycode
SliceNamecountrycode
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.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(SC-coding) (Extension Type: Coding)
InvariantsDefined 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())
50. Address.country.value
Definition

The actual value

Control0..1
Typestring
Max Length1048576
51. Address.period
Definition

Time period when address was/is in use.

Control0..1
TypePeriod
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>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))