CH Core (R4)
4.0.0-ballot - ballot
CH Core (R4)
4.0.0-ballot - ballot
This page is part of the CH Core (R4) (v4.0.0-ballot: STU Ballot 1) based on FHIR 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-06-27 |
Definitions for the ch-core-address data type profile.
Guidance on how to interpret the contents of this table can be found here.
| 1. Address | |
| 2. Address.line | |
| Control | 0..? |
| 3. Address.line.extension | |
| Control | 0..? |
| 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:
|
| 4. Address.line.extension:addressLine1 | |
| SliceName | addressLine1 |
| Control | 0..1 |
| Type | Extension(ECH0010AddressLineType) (Extension Type: code) |
| 5. Address.line.extension:addressLine1.value[x] | |
| Control | 1..? |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 6. Address.line.extension:addressLine1.value[x]:valueCode | |
| SliceName | 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 |
| 7. Address.line.extension:addressLine2 | |
| SliceName | addressLine2 |
| Control | 0..1 |
| Type | Extension(ECH0010AddressLineType) (Extension Type: code) |
| 8. Address.line.extension:addressLine2.value[x] | |
| Control | 1..? |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 9. Address.line.extension:addressLine2.value[x]:valueCode | |
| SliceName | 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 |
| 10. Address.line.extension:street | |
| SliceName | street |
| Control | 0..1 |
| Type | Extension(ECH0010AddressLineType) (Extension Type: code) |
| 11. Address.line.extension:street.value[x] | |
| Control | 1..? |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 12. Address.line.extension:street.value[x]:valueCode | |
| SliceName | 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 |
| 13. Address.line.extension:streetName | |
| SliceName | streetName |
| Control | 0..1 |
| Type | Extension(ADXP-streetName) (Extension Type: string) |
| 14. Address.line.extension:houseNumber | |
| SliceName | houseNumber |
| Control | 0..1 |
| Type | Extension(ADXP-houseNumber) (Extension Type: string) |
| 15. Address.line.extension:unitID | |
| SliceName | unitID |
| Control | 0..1 |
| Type | Extension(ADXP-unitID) (Extension Type: string) |
| 16. Address.line.extension:postOfficeBoxText | |
| SliceName | postOfficeBoxText |
| Control | 0..1 |
| Type | Extension(ECH0010AddressLineType) (Extension Type: code) |
| 17. Address.line.extension:postOfficeBoxText.value[x] | |
| Control | 1..? |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 18. Address.line.extension:postOfficeBoxText.value[x]:valueCode | |
| SliceName | 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 |
| 19. Address.line.extension:postOfficeBoxNumber | |
| SliceName | postOfficeBoxNumber |
| Control | 0..1 |
| Type | Extension(ADXP-postBox) (Extension Type: string) |
| 20. Address.city | |
| 21. Address.city.extension | |
| Control | 0..? |
| 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:
|
| 22. Address.city.extension:bfs | |
| SliceName | bfs |
| Control | 0..1 |
| Type | Extension(ECH007MunicipalityId) (Extension Type: string) |
| 23. Address.district | |
| 24. Address.state | |
| 25. Address.postalCode | |
| 26. Address.country | |
| 27. Address.country.extension | |
| Control | 0..? |
| 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:
|
| 28. 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 |
| 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 (: ((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.
| 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..1 |
| Binding | The codes SHALL be taken from AddressUse The use of an address. |
| Type | code |
| Is Modifier | true |
| 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. |
| 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.city | |
| Definition | The name of the city, town, suburb, village or other community or delivery center. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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())) |
| 4. 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. |
| 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.city.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 5. 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()) |
| 6. Address.district | |
| Definition | The name of the administrative area (county). |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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())) |
| 7. 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). |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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())) |
| 8. Address.postalCode | |
| Definition | A postal code designating a region defined by the postal service. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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())) |
| 9. Address.country | |
| Definition | Country - a nation as commonly understood or generally accepted. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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())) |
| 10. 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. |
| 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.country.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 11. 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 (: ((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'))) 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()) |
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:
|
| 4. Address.use | |
| Definition | The purpose of this address. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AddressUse The use of an address |
| Type | code |
| Is Modifier | true |
| 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. |
| 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..1 |
| Binding | The codes SHALL be taken from AddressType The type of an address (physical / postal) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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.line.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 |
| 9. Address.line.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.line.extension. The slices are ordered and Open, and can be differentiated using the following discriminators:
|
| 10. Address.line.extension:addressLine1 | |
| SliceName | addressLine1 |
| Definition | eCH-0010: Extension to define line types for an address |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(ECH0010AddressLineType) (Extension Type: code) |
| 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()) |
| 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. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 12. Address.line.extension:addressLine1.extension | |
| Definition | An Extension |
| Control | 0..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.line.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 13. Address.line.extension:addressLine1.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 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 Value | http://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). |
| Control | 1..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 |
| Summary | false |
| Invariants | Defined on this element 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:
|
| 15. Address.line.extension:addressLine1.value[x]:valueCode | |
| SliceName | 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). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from eCH-010 Address Line Type; other codes may be used where these codes are not suitable 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] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Fixed Value | addressLine1 |
| Invariants | Defined 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 | |
| SliceName | addressLine2 |
| Definition | eCH-0010: Extension to define line types for an address |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(ECH0010AddressLineType) (Extension Type: code) |
| 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()) |
| 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. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 18. Address.line.extension:addressLine2.extension | |
| Definition | An Extension |
| Control | 0..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.line.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 19. Address.line.extension:addressLine2.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 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 Value | http://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). |
| Control | 1..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 |
| Summary | false |
| Invariants | Defined on this element 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:
|
| 21. Address.line.extension:addressLine2.value[x]:valueCode | |
| SliceName | 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). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from eCH-010 Address Line Type; other codes may be used where these codes are not suitable 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] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Fixed Value | addressLine2 |
| Invariants | Defined 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 | |
| SliceName | street |
| Definition | eCH-0010: Extension to define line types for an address |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(ECH0010AddressLineType) (Extension Type: code) |
| 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()) |
| 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. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 24. Address.line.extension:street.extension | |
| Definition | An Extension |
| Control | 0..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.line.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 25. Address.line.extension:street.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 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 Value | http://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). |
| Control | 1..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 |
| Summary | false |
| Invariants | Defined on this element 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:
|
| 27. Address.line.extension:street.value[x]:valueCode | |
| SliceName | 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). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from eCH-010 Address Line Type; other codes may be used where these codes are not suitable 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] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Fixed Value | street |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 28. Address.line.extension:streetName | |
| SliceName | streetName |
| Definition | streetName. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(ADXP-streetName) (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()) |
| 29. Address.line.extension:houseNumber | |
| SliceName | 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. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(ADXP-houseNumber) (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()) |
| 30. Address.line.extension:unitID | |
| SliceName | unitID |
| Definition | The number or name of a specific unit contained within a building or complex, as assigned by that building or complex. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(ADXP-unitID) (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()) |
| 31. Address.line.extension:postOfficeBoxText | |
| SliceName | postOfficeBoxText |
| Definition | eCH-0010: Extension to define line types for an address |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(ECH0010AddressLineType) (Extension Type: code) |
| 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()) |
| 32. 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. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 33. Address.line.extension:postOfficeBoxText.extension | |
| Definition | An Extension |
| Control | 0..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.line.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 34. Address.line.extension:postOfficeBoxText.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 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 Value | http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype |
| 35. 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). |
| Control | 1..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 |
| Summary | false |
| Invariants | Defined on this element 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:
|
| 36. Address.line.extension:postOfficeBoxText.value[x]:valueCode | |
| SliceName | 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). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from eCH-010 Address Line Type; other codes may be used where these codes are not suitable 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] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Fixed Value | postOfficeBoxText |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 37. Address.line.extension:postOfficeBoxNumber | |
| SliceName | postOfficeBoxNumber |
| Definition | A numbered box located in a post station. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(ADXP-postBox) (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()) |
| 38. Address.line.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 |
| 39. Address.city | |
| Definition | The name of the city, town, suburb, village or other community or delivery center. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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())) |
| 40. 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 |
| 41. 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:
|
| 42. 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()) |
| 43. 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 |
| 44. Address.district | |
| Definition | The name of the administrative area (county). |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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())) |
| 45. 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). |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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())) |
| 46. Address.postalCode | |
| Definition | A postal code designating a region defined by the postal service. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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())) |
| 47. Address.country | |
| Definition | Country - a nation as commonly understood or generally accepted. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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())) |
| 48. 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 |
| 49. 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:
|
| 50. 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 (: ((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'))) 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()) |
| 51. 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 |
| 52. Address.period | |
| Definition | Time period when address was/is in use. |
| Control | 0..1 |
| 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())) |