CH Core (R4)
3.0.0 - STU3
CH Core (R4)
3.0.0 - STU3
This page is part of the CH Core (R4) (v3.0.0: STU 3) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
| Official URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-address | Version: 3.0.0 | |||
| Active as of 2018-11-27 | Computable Name: CHCoreAddress | |||
Copyright/Legal: CC-BY-SA-4.0 |
||||
address incorporating eCH-0010 postal address extensions
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Address
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
  line | 0..* | string | Street name, number, direction & P.O. Box etc. | |
   Slices for extension | 0..* | Extension | Extension Slice: Ordered, Open by value:url, value:value | |
   addressLine1 | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
  valueCode | 1..1 | code | Value of extension Fixed Value: addressLine1 | |
| addressLine2 | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| valueCode | 1..1 | code | Value of extension Fixed Value: addressLine2 | |
| street | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| valueCode | 1..1 | code | Value of extension Fixed Value: street | |
 houseNumber | 0..1 | string | houseNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |
| unitID | 0..1 | string | unitID, dwellingNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID | |
| postOfficeBoxText | 0..1 | code | Postbox addresses need an postbox text and optional postbox number URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| valueCode | 1..1 | code | Value of extension Fixed Value: postOfficeBoxText | |
 postOfficeBoxNumber | 0..1 | string | Optional postOfficeBoxNumber as a separate part of the postOfficeBoxText URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox | |
| city | Σ | 0..1 | string | Name of city, town etc. |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 bfs | 0..1 | string | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid | |
| district | Σ | 0..1 | string | District name (aka county) |
| state | 0..1 | string | Sub-unit of country (abbreviations ok) | |
| postalCode | 0..1 | string | Postal code for area | |
| country | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| countrycode | C | 0..1 | Coding | ISO Country Alpha-2 or ISO Country Alpha-3 code URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding Binding: (unbound) (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc. ch-addr-1: ISO Country Alpha-2 or ISO Country Alpha-3 code |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| ch-addr-1 | error | Address.country.extension:countrycode | ISO Country Alpha-2 or ISO Country Alpha-3 code : ((valueCoding.code.length()=2) and valueCoding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((valueCoding.code.length() = 3) and valueCoding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
| Slices for extension | 0..* | Extension | Extension Slice: Ordered, Open by value:url, value:value | |
| addressLine1 | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
 extension | 0..0 | |||
| url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
 Slices for value[x] | 0..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. Fixed Value: addressLine1 | |
| addressLine2 | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
| Slices for value[x] | 0..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. Fixed Value: addressLine2 | |
| street | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
| Slices for value[x] | 0..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. Fixed Value: street | |
| houseNumber | 0..1 | string | houseNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |
| unitID | 0..1 | string | unitID, dwellingNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID | |
| postOfficeBoxText | 0..1 | code | Postbox addresses need an postbox text and optional postbox number URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
| Slices for value[x] | 0..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. Fixed Value: postOfficeBoxText | |
| postOfficeBoxNumber | 0..1 | string | Optional postOfficeBoxNumber as a separate part of the postOfficeBoxText URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox | |
| city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| bfs | 0..1 | string | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid | |
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison |
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
| postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 |
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| countrycode | C | 0..1 | Coding | ISO Country Alpha-2 or ISO Country Alpha-3 code URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding Binding: (unbound) (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc. ch-addr-1: ISO Country Alpha-2 or ISO Country Alpha-3 code |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Address.use | required | AddressUse |
| Address.line.extension:addressLine1.value[x]:valueCode | required | Fixed Value: addressLine1 |
| Address.line.extension:addressLine2.value[x]:valueCode | required | Fixed Value: addressLine2 |
| Address.line.extension:street.value[x]:valueCode | required | Fixed Value: street |
| Address.line.extension:postOfficeBoxText.value[x]:valueCode | required | Fixed Value: postOfficeBoxText |
| Id | Grade | Path(s) | Details | Requirements |
| ch-addr-1 | error | Address.country.extension:countrycode | ISO Country Alpha-2 or ISO Country Alpha-3 code : ((valueCoding.code.length()=2) and valueCoding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((valueCoding.code.length() = 3) and valueCoding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')) | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
| line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension | 0..* | Extension | Extension Slice: Ordered, Open by value:url, value:value | |
| addressLine1 | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
| Slices for value[x] | 0..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. Fixed Value: addressLine1 | |
| addressLine2 | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
| Slices for value[x] | 0..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. Fixed Value: addressLine2 | |
| street | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
| Slices for value[x] | 0..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. Fixed Value: street | |
| houseNumber | 0..1 | string | houseNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |
| unitID | 0..1 | string | unitID, dwellingNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID | |
| postOfficeBoxText | 0..1 | code | Postbox addresses need an postbox text and optional postbox number URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
| Slices for value[x] | 0..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. Fixed Value: postOfficeBoxText | |
| postOfficeBoxNumber | 0..1 | string | Optional postOfficeBoxNumber as a separate part of the postOfficeBoxText URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| bfs | 0..1 | string | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison |
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
| postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 |
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| countrycode | C | 0..1 | Coding | ISO Country Alpha-2 or ISO Country Alpha-3 code URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding Binding: (unbound) (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc. ch-addr-1: ISO Country Alpha-2 or ISO Country Alpha-3 code |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
 period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Address.use | required | AddressUse |
| Address.type | required | AddressType |
| Address.line.extension:addressLine1.value[x]:valueCode | required | Fixed Value: addressLine1 |
| Address.line.extension:addressLine2.value[x]:valueCode | required | Fixed Value: addressLine2 |
| Address.line.extension:street.value[x]:valueCode | required | Fixed Value: street |
| Address.line.extension:postOfficeBoxText.value[x]:valueCode | required | Fixed Value: postOfficeBoxText |
| Id | Grade | Path(s) | Details | Requirements |
| ch-addr-1 | error | Address.country.extension:countrycode | ISO Country Alpha-2 or ISO Country Alpha-3 code : ((valueCoding.code.length()=2) and valueCoding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((valueCoding.code.length() = 3) and valueCoding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')) | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Address
Summary
Mandatory: 0 element (4 nested mandatory elements)
Fixed Value: 4 elements
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Address
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| line | 0..* | string | Street name, number, direction & P.O. Box etc. | |
| Slices for extension | 0..* | Extension | Extension Slice: Ordered, Open by value:url, value:value | |
| addressLine1 | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| valueCode | 1..1 | code | Value of extension Fixed Value: addressLine1 | |
| addressLine2 | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| valueCode | 1..1 | code | Value of extension Fixed Value: addressLine2 | |
| street | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| valueCode | 1..1 | code | Value of extension Fixed Value: street | |
| houseNumber | 0..1 | string | houseNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |
| unitID | 0..1 | string | unitID, dwellingNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID | |
| postOfficeBoxText | 0..1 | code | Postbox addresses need an postbox text and optional postbox number URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| valueCode | 1..1 | code | Value of extension Fixed Value: postOfficeBoxText | |
| postOfficeBoxNumber | 0..1 | string | Optional postOfficeBoxNumber as a separate part of the postOfficeBoxText URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox | |
| city | Σ | 0..1 | string | Name of city, town etc. |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| bfs | 0..1 | string | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid | |
| district | Σ | 0..1 | string | District name (aka county) |
| state | 0..1 | string | Sub-unit of country (abbreviations ok) | |
| postalCode | 0..1 | string | Postal code for area | |
| country | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| countrycode | C | 0..1 | Coding | ISO Country Alpha-2 or ISO Country Alpha-3 code URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding Binding: (unbound) (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc. ch-addr-1: ISO Country Alpha-2 or ISO Country Alpha-3 code |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| ch-addr-1 | error | Address.country.extension:countrycode | ISO Country Alpha-2 or ISO Country Alpha-3 code : ((valueCoding.code.length()=2) and valueCoding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((valueCoding.code.length() = 3) and valueCoding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
| Slices for extension | 0..* | Extension | Extension Slice: Ordered, Open by value:url, value:value | |
| addressLine1 | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
| Slices for value[x] | 0..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. Fixed Value: addressLine1 | |
| addressLine2 | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
| Slices for value[x] | 0..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. Fixed Value: addressLine2 | |
| street | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
| Slices for value[x] | 0..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. Fixed Value: street | |
| houseNumber | 0..1 | string | houseNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |
| unitID | 0..1 | string | unitID, dwellingNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID | |
| postOfficeBoxText | 0..1 | code | Postbox addresses need an postbox text and optional postbox number URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
| Slices for value[x] | 0..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. Fixed Value: postOfficeBoxText | |
| postOfficeBoxNumber | 0..1 | string | Optional postOfficeBoxNumber as a separate part of the postOfficeBoxText URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox | |
| city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| bfs | 0..1 | string | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid | |
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison |
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
| postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 |
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| countrycode | C | 0..1 | Coding | ISO Country Alpha-2 or ISO Country Alpha-3 code URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding Binding: (unbound) (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc. ch-addr-1: ISO Country Alpha-2 or ISO Country Alpha-3 code |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Address.use | required | AddressUse |
| Address.line.extension:addressLine1.value[x]:valueCode | required | Fixed Value: addressLine1 |
| Address.line.extension:addressLine2.value[x]:valueCode | required | Fixed Value: addressLine2 |
| Address.line.extension:street.value[x]:valueCode | required | Fixed Value: street |
| Address.line.extension:postOfficeBoxText.value[x]:valueCode | required | Fixed Value: postOfficeBoxText |
| Id | Grade | Path(s) | Details | Requirements |
| ch-addr-1 | error | Address.country.extension:countrycode | ISO Country Alpha-2 or ISO Country Alpha-3 code : ((valueCoding.code.length()=2) and valueCoding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((valueCoding.code.length() = 3) and valueCoding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')) | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
| line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension | 0..* | Extension | Extension Slice: Ordered, Open by value:url, value:value | |
| addressLine1 | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
| Slices for value[x] | 0..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. Fixed Value: addressLine1 | |
| addressLine2 | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
| Slices for value[x] | 0..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. Fixed Value: addressLine2 | |
| street | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
| Slices for value[x] | 0..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. Fixed Value: street | |
| houseNumber | 0..1 | string | houseNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |
| unitID | 0..1 | string | unitID, dwellingNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID | |
| postOfficeBoxText | 0..1 | code | Postbox addresses need an postbox text and optional postbox number URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
| Slices for value[x] | 0..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. Fixed Value: postOfficeBoxText | |
| postOfficeBoxNumber | 0..1 | string | Optional postOfficeBoxNumber as a separate part of the postOfficeBoxText URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| bfs | 0..1 | string | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison |
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
| postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 |
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| countrycode | C | 0..1 | Coding | ISO Country Alpha-2 or ISO Country Alpha-3 code URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding Binding: (unbound) (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc. ch-addr-1: ISO Country Alpha-2 or ISO Country Alpha-3 code |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Address.use | required | AddressUse |
| Address.type | required | AddressType |
| Address.line.extension:addressLine1.value[x]:valueCode | required | Fixed Value: addressLine1 |
| Address.line.extension:addressLine2.value[x]:valueCode | required | Fixed Value: addressLine2 |
| Address.line.extension:street.value[x]:valueCode | required | Fixed Value: street |
| Address.line.extension:postOfficeBoxText.value[x]:valueCode | required | Fixed Value: postOfficeBoxText |
| Id | Grade | Path(s) | Details | Requirements |
| ch-addr-1 | error | Address.country.extension:countrycode | ISO Country Alpha-2 or ISO Country Alpha-3 code : ((valueCoding.code.length()=2) and valueCoding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((valueCoding.code.length() = 3) and valueCoding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')) | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Address
Summary
Mandatory: 0 element (4 nested mandatory elements)
Fixed Value: 4 elements
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 Switzerland. Package ch.fhir.ig.ch-core#3.0.0 based on FHIR 4.0.1. Generated 2022-12-21
Links: Table of Contents |
QA Report
| Propose a change