CH Core (R4)
4.0.1 - trial-use
CH Core (R4)
4.0.1 - trial-use
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
| Active as of 2023-12-28 |
Definitions for the ch-core-address data type profile.
Guidance on how to interpret the contents of this table can be found here
| 0. Address | |
| Invariants | ch-addr-2: 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')))) |
| 2. Address.line | |
| 4. Address.line.extension | |
| Slicing | This element introduces a set of slices on Address.line.extension. The slices are ordered and Open, and can be differentiated using the following discriminators: |
| 6. Address.line.extension:addressLine1 | |
| Slice Name | addressLine1 |
| Control | 0..1 |
| Type | Extension(Address Line Type) (Extension Type: code) |
| 8. Address.line.extension:addressLine1.value[x] | |
| Control | 1..? |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 10. Address.line.extension:addressLine1.value[x]:valueCode | |
| Slice Name | valueCode |
| Control | 1..? |
| Type | code |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Fixed Value | addressLine1 |
| 12. Address.line.extension:addressLine2 | |
| Slice Name | addressLine2 |
| Control | 0..1 |
| Type | Extension(Address Line Type) (Extension Type: code) |
| 14. Address.line.extension:addressLine2.value[x] | |
| Control | 1..? |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 16. Address.line.extension:addressLine2.value[x]:valueCode | |
| Slice Name | valueCode |
| Control | 1..? |
| Type | code |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Fixed Value | addressLine2 |
| 18. Address.line.extension:street | |
| Slice Name | street |
| Control | 0..1 |
| Type | Extension(Address Line Type) (Extension Type: code) |
| 20. Address.line.extension:street.value[x] | |
| Control | 1..? |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 22. Address.line.extension:street.value[x]:valueCode | |
| Slice Name | valueCode |
| Control | 1..? |
| Type | code |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Fixed Value | street |
| 24. Address.line.extension:streetName | |
| Slice Name | streetName |
| Short | street part of the street line, e.g. withouth housenumber |
| Control | 0..1 |
| Type | Extension(ADXP-streetName) (Extension Type: string) |
| 26. Address.line.extension:houseNumber | |
| Slice Name | houseNumber |
| Short | houseNumber part of the street line |
| Control | 0..1 |
| Type | Extension(ADXP-houseNumber) (Extension Type: string) |
| 28. Address.line.extension:unitID | |
| Slice Name | unitID |
| Short | unitID, dwellingNumber part of the street line |
| Control | 0..1 |
| Type | Extension(ADXP-unitID) (Extension Type: string) |
| 30. Address.line.extension:postOfficeBoxText | |
| Slice Name | postOfficeBoxText |
| Short | Postbox addresses need an postbox text and optional postbox number |
| Control | 0..1 |
| Type | Extension(Address Line Type) (Extension Type: code) |
| 32. Address.line.extension:postOfficeBoxText.value[x] | |
| Control | 1..? |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 34. Address.line.extension:postOfficeBoxText.value[x]:valueCode | |
| Slice Name | valueCode |
| Control | 1..? |
| Type | code |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Fixed Value | postOfficeBoxText |
| 36. Address.line.extension:postOfficeBoxNumber | |
| Slice Name | postOfficeBoxNumber |
| Short | Optional postOfficeBoxNumber as a separate part of the postOfficeBoxText |
| Control | 0..1 |
| Type | Extension(ADXP-postBox) (Extension Type: string) |
| 38. Address.city | |
| 40. Address.city.extension | |
| 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: |
| 42. Address.city.extension:bfs | |
| Slice Name | bfs |
| Control | 0..1 |
| Type | Extension(eCH-0007 Municipality Id – BFS Gemeindenummer) (Extension Type: string) |
| 44. Address.district | |
| 46. Address.state | |
| Binding | For example codes, see eCH-0007 Canton Abbreviation incl. FL (Fürstentum Liechtenstein) Use these values for a Swiss or Liechtenstein address |
| 48. Address.postalCode | |
| 50. Address.country | |
| 52. Address.country.extension | |
| 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: |
| 54. Address.country.extension:countrycode | |
| Slice Name | 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. |
| Short | ISO Country Alpha-2 or ISO Country Alpha-3 code |
| Control | 0..1 |
| Type | Extension(SC-coding) (Extension Type: Coding) |
| Invariants | ch-addr-1: 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'))) |
Guidance on how to interpret the contents of this table can be found here
| 0. 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. |
| Short | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
| 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). |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ch-addr-2: 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')))) |
| 2. Address.use | |
| Definition | The purpose of this address. |
| Short | home | work | temp | old | billing - purpose of this address |
| Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 The use of an address. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows an appropriate address to be chosen from a list of many. |
| Example | <br/><b>General</b>:home |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. Address.city | |
| Definition | The name of the city, town, suburb, village or other community or delivery center. |
| Short | Name of city, town etc. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Alternate Names | Municpality |
| Example | <br/><b>General</b>:Erewhon |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. Address.city.extension | |
| Definition | An Extension 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. |
| Short | ExtensionAdditional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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())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: |
| 8. Address.city.extension:bfs | |
| Slice Name | bfs |
| Definition | Extension for eCH-0011 - bfs number (ministry of statistics number) |
| Short | Extension |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(eCH-0007 Municipality Id – BFS Gemeindenummer) (Extension Type: string) |
| Is Modifier | false |
| Invariants | 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())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 10. Address.district | |
| Definition | The name of the administrative area (county). |
| Short | District name (aka 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. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Alternate Names | County |
| Example | <br/><b>General</b>:Madison |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. 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). |
| Short | Sub-unit of country (abbreviations ok) |
| Control | 0..1 |
| Binding | For example codes, see For codes, see eCH-0007 Canton Abbreviation incl. FL (Fürstentum Liechtenstein) Use these values for a Swiss or Liechtenstein address |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Alternate Names | Province, Territory |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 14. Address.postalCode | |
| Definition | A postal code designating a region defined by the postal service. |
| Short | Postal code for area |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Alternate Names | Zip |
| Example | <br/><b>General</b>:9132 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. Address.country | |
| Definition | Country - a nation as commonly understood or generally accepted. |
| Short | Country (e.g. can be ISO 3166 2 or 3 letter code) |
| Comments | ISO 3166 3 letter codes can be used in place of a human readable country name. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 18. Address.country.extension | |
| Definition | An Extension 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. |
| Short | ExtensionAdditional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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())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: |
| 20. Address.country.extension:countrycode | |
| Slice Name | 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. |
| Short | ISO Country Alpha-2 or ISO Country Alpha-3 code |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(SC-coding) (Extension Type: Coding) |
| Is Modifier | false |
| Invariants | 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())ch-addr-1: 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')))ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Guidance on how to interpret the contents of this table can be found here
| 0. 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. |
| Short | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
| 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). |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ch-addr-2: 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')))) |
| 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. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 4. 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. |
| Short | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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: |
| 6. Address.use | |
| Definition | The purpose of this address. |
| Short | home | work | temp | old | billing - purpose of this address |
| Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AddressUse The use of an address. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows an appropriate address to be chosen from a list of many. |
| Example | <br/><b>General</b>:home |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. 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. |
| Short | postal | physical | both |
| 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). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AddressType The type of an address (physical / postal). |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | <br/><b>General</b>:both |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. 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. |
| Short | Text representation of the address |
| 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. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | A renderable, unencoded form. |
| Example | <br/><b>General</b>:137 Nowhere Street, Erewhon 9132 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. 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. |
| Short | Street name, number, direction & P.O. Box etc. |
| Control | 0..* |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | <br/><b>General</b>:137 Nowhere Street |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 14. Address.line.id | |
| Definition | unique id for the element within a resource (for internal references) |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 16. Address.line.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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.line.extension. The slices are ordered and Open, and can be differentiated using the following discriminators: |
| 18. Address.line.extension:addressLine1 | |
| Slice Name | addressLine1 |
| Definition | eCH-0010: Extension to define line types for an address |
| Short | Extension |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(Address Line Type) (Extension Type: code) |
| Is Modifier | false |
| Invariants | 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.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. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 22. Address.line.extension:addressLine1.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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.line.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: |
| 24. Address.line.extension:addressLine1.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| 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. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype |
| 26. 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). |
| Short | Value of extension |
| Control | 1..1 |
| Type | code |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This 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: |
| 28. Address.line.extension:addressLine1.value[x]:valueCode | |
| Slice Name | valueCode |
| 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). |
| Short | Value of extension |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from eCH-010 Address Line Type A set of codes advising a system or user which name in a set of names to select for a given purpose. |
| Type | code |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Fixed Value | addressLine1 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 30. Address.line.extension:addressLine2 | |
| Slice Name | addressLine2 |
| Definition | eCH-0010: Extension to define line types for an address |
| Short | Extension |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(Address Line Type) (Extension Type: code) |
| Is Modifier | false |
| Invariants | 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()) |
| 32. 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. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 34. Address.line.extension:addressLine2.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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.line.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: |
| 36. Address.line.extension:addressLine2.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| 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. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype |
| 38. 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). |
| Short | Value of extension |
| Control | 1..1 |
| Type | code |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This 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: |
| 40. Address.line.extension:addressLine2.value[x]:valueCode | |
| Slice Name | valueCode |
| 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). |
| Short | Value of extension |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from eCH-010 Address Line Type A set of codes advising a system or user which name in a set of names to select for a given purpose. |
| Type | code |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Fixed Value | addressLine2 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 42. Address.line.extension:street | |
| Slice Name | street |
| Definition | eCH-0010: Extension to define line types for an address |
| Short | Extension |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(Address Line Type) (Extension Type: code) |
| Is Modifier | false |
| Invariants | 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()) |
| 44. 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. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 46. Address.line.extension:street.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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.line.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: |
| 48. Address.line.extension:street.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| 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. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype |
| 50. 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). |
| Short | Value of extension |
| Control | 1..1 |
| Type | code |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This 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: |
| 52. Address.line.extension:street.value[x]:valueCode | |
| Slice Name | valueCode |
| 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). |
| Short | Value of extension |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from eCH-010 Address Line Type A set of codes advising a system or user which name in a set of names to select for a given purpose. |
| Type | code |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Fixed Value | street |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 54. Address.line.extension:streetName | |
| Slice Name | streetName |
| Definition | streetName. |
| Short | street part of the street line, e.g. withouth housenumber |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(ADXP-streetName) (Extension Type: string) |
| Is Modifier | false |
| Invariants | 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()) |
| 56. Address.line.extension:houseNumber | |
| Slice Name | houseNumber |
| 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. |
| Short | houseNumber part of the street line |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(ADXP-houseNumber) (Extension Type: string) |
| Is Modifier | false |
| Invariants | 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()) |
| 58. Address.line.extension:unitID | |
| Slice Name | unitID |
| Definition | The number or name of a specific unit contained within a building or complex, as assigned by that building or complex. |
| Short | unitID, dwellingNumber part of the street line |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(ADXP-unitID) (Extension Type: string) |
| Is Modifier | false |
| Invariants | 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()) |
| 60. Address.line.extension:postOfficeBoxText | |
| Slice Name | postOfficeBoxText |
| Definition | eCH-0010: Extension to define line types for an address |
| Short | Postbox addresses need an postbox text and optional postbox number |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(Address Line Type) (Extension Type: code) |
| Is Modifier | false |
| Invariants | 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()) |
| 62. 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. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 64. Address.line.extension:postOfficeBoxText.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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.line.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: |
| 66. Address.line.extension:postOfficeBoxText.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| 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. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype |
| 68. 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). |
| Short | Value of extension |
| Control | 1..1 |
| Type | code |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This 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: |
| 70. Address.line.extension:postOfficeBoxText.value[x]:valueCode | |
| Slice Name | valueCode |
| 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). |
| Short | Value of extension |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from eCH-010 Address Line Type A set of codes advising a system or user which name in a set of names to select for a given purpose. |
| Type | code |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Fixed Value | postOfficeBoxText |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 72. Address.line.extension:postOfficeBoxNumber | |
| Slice Name | postOfficeBoxNumber |
| Definition | A numbered box located in a post station. |
| Short | Optional postOfficeBoxNumber as a separate part of the postOfficeBoxText |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(ADXP-postBox) (Extension Type: string) |
| Is Modifier | false |
| Invariants | 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()) |
| 74. Address.line.value | |
| Definition | The actual value |
| Short | Primitive value for string |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Max Length | 1048576 |
| 76. Address.city | |
| Definition | The name of the city, town, suburb, village or other community or delivery center. |
| Short | Name of city, town etc. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Alternate Names | Municpality |
| Example | <br/><b>General</b>:Erewhon |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 78. Address.city.id | |
| Definition | unique id for the element within a resource (for internal references) |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 80. Address.city.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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: |
| 82. Address.city.extension:bfs | |
| Slice Name | bfs |
| Definition | Extension for eCH-0011 - bfs number (ministry of statistics number) |
| Short | Extension |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(eCH-0007 Municipality Id – BFS Gemeindenummer) (Extension Type: string) |
| Is Modifier | false |
| Invariants | 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()) |
| 84. Address.city.value | |
| Definition | The actual value |
| Short | Primitive value for string |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Max Length | 1048576 |
| 86. Address.district | |
| Definition | The name of the administrative area (county). |
| Short | District name (aka 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. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Alternate Names | County |
| Example | <br/><b>General</b>:Madison |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 88. 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). |
| Short | Sub-unit of country (abbreviations ok) |
| Control | 0..1 |
| Binding | For example codes, see eCH-0007 Canton Abbreviation incl. FL (Fürstentum Liechtenstein) Use these values for a Swiss or Liechtenstein address |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Alternate Names | Province, Territory |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 90. Address.postalCode | |
| Definition | A postal code designating a region defined by the postal service. |
| Short | Postal code for area |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Alternate Names | Zip |
| Example | <br/><b>General</b>:9132 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 92. Address.country | |
| Definition | Country - a nation as commonly understood or generally accepted. |
| Short | Country (e.g. can be ISO 3166 2 or 3 letter code) |
| Comments | ISO 3166 3 letter codes can be used in place of a human readable country name. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 94. Address.country.id | |
| Definition | unique id for the element within a resource (for internal references) |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 96. Address.country.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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: |
| 98. Address.country.extension:countrycode | |
| Slice Name | 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. |
| Short | ISO Country Alpha-2 or ISO Country Alpha-3 code |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(SC-coding) (Extension Type: Coding) |
| Is Modifier | false |
| Invariants | 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())ch-addr-1: 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'))) |
| 100. Address.country.value | |
| Definition | The actual value |
| Short | Primitive value for string |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Max Length | 1048576 |
| 102. Address.period | |
| Definition | Time period when address was/is in use. |
| Short | Time period when address was/is in use |
| Control | 0..1 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows addresses to be placed in historical context. |
| Example | <br/><b>General</b>:<valuePeriod xmlns="http://hl7.org/fhir"><br/> <start value="2010-03-23"/><br/> <end value="2010-07-01"/><br/></valuePeriod><br/> |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |