CH Core (R4)
7.0.0-ballot-ci-build - ci-build Switzerland flag

CH Core (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 7.0.0-ballot-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-core/ and changes regularly. See the Directory of published versions

Data Type Profile: CHCoreAddressECH10 - Detailed Descriptions

Active as of 2026-03-12

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

Guidance on how to interpret the contents of this table can be foundhere

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.

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


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

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-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-codedString').empty() or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-codedString').value.code.startsWith('CH') = false) or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-codedString').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.

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

Control0..1
BindingThe codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

The use of an address.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows an appropriate address to be chosen from a list of many.

ExampleGeneral: home
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. 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.

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


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

Control0..1
BindingThe codes SHALL be taken from AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

The type of an address (physical / postal).

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Valuepostal
ExampleGeneral: both
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Address.city
Definition

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

ShortName of city, town etc.
Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesMunicpality
ExampleGeneral: Erewhon
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Address.city.extension:bfs
Slice Namebfs
Definition

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

ShortExtension
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(eCH-0007 Municipality Id – BFS Gemeindenummer) (Extension Type: string)
Is Modifierfalse
Summaryfalse
Invariantsele-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.postalCode
Definition

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

ShortPostal code for area
Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesZip
ExampleGeneral: 9132
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Address.country
Definition

Country - a nation as commonly understood or generally accepted.

ShortCountry (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.

Control10..1
BindingThe codes SHOULD be taken from For codes, see BFS Verzeichnis der Staaten und Gebiete
(preferred to http://fhir.ch/ig/ch-term/ValueSet/bfs-country-codes)
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Address.country.extension:countrycode
Slice Namecountrycode
Definition

BFS defines the valid set of countries. Values are from the 'ISO 3166-1 country codes' code system.

ShortISO Country Alpha-2 or ISO Country Alpha-3 code
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Coded string) (Extension Type: Coding)
Is Modifierfalse
Summaryfalse
Invariantsele-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())
16. Address.country.extension:countrycode.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.

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

Control0..0*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Address.country.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 18. Address.country.extension:countrycode.url
    Definition

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

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

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-codedString
    20. Address.country.extension:countrycode.value[x]
    Definition

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

    ShortValue of extension
    Control10..1
    BindingUnless not suitable, these codes SHALL be taken from For codes, see BFS Verzeichnis der Staaten und Gebiete
    (extensible to http://fhir.ch/ig/ch-term/ValueSet/bfs-country-codes)
    TypeCoding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. Address.period
    Definition

    Time period when address was/is in use.

    ShortTime period when address was/is in use
    Control0..01
    TypePeriod
    Is Modifierfalse
    Summarytrue
    Requirements

    Allows addresses to be placed in historical context.

    ExampleGeneral: { "start" : "2010-03-23", "end" : "2010-07-01" }
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

    Guidance on how to interpret the contents of this table can be foundhere

    0. Address
    2. Address.type
    Shortpostal
    Fixed Valuepostal
    4. Address.city
    Control1..?
    6. Address.postalCode
    Control1..?
    8. Address.country
    Control1..?
    10. Address.period
    Control0..0

    Guidance on how to interpret the contents of this table can be foundhere

    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.

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

    Control0..*
    This element is affected by the following invariants: ele-1
    Is Modifierfalse
    Invariantsele-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-codedString').empty() or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-codedString').value.code.startsWith('CH') = false) or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-codedString').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.

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    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.

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

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on Address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 6. Address.use
      Definition

      The purpose of this address.

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

      Control0..1
      BindingThe codes SHALL be taken from AddressUse
      (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

      The use of an address.

      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Allows an appropriate address to be chosen from a list of many.

      ExampleGeneral: home
      Invariantsele-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.

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

      Control0..1
      BindingThe codes SHALL be taken from AddressType
      (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

      The type of an address (physical / postal).

      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Fixed Valuepostal
      ExampleGeneral: both
      Invariantsele-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.

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

      Control0..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      A renderable, unencoded form.

      ExampleGeneral: 137 Nowhere Street, Erewhon 9132
      Invariantsele-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.

      ShortStreet name, number, direction & P.O. Box etc.
      Control0..*
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      ExampleGeneral: 137 Nowhere Street
      Invariantsele-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)

      Shortxml:id (or equivalent in JSON)
      Control0..1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      16. Address.line.extension
      Definition

      An Extension

      ShortExtension
      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on Address.line.extension. The slices areOrdered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • value @ value
      • 18. Address.line.extension:addressLine1
        Slice NameaddressLine1
        Definition

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

        ShortExtension
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Address Line Type) (Extension Type: code)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-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.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        22. Address.line.extension:addressLine1.extension
        Definition

        An Extension

        ShortExtension
        Control0..0
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingThis element introduces a set of slices on Address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 24. Address.line.extension:addressLine1.url
          Definition

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

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

          Control1..1
          Typeuri
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          Fixed Valuehttp://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).

          ShortValue of extension
          Control1..1
          Typecode
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          SlicingThis element introduces a set of slices on Address.line.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
          • type @ $this
          • 28. Address.line.extension:addressLine1.value[x]:valueCode
            Slice NamevalueCode
            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).

            ShortValue of extension
            Control1..1
            BindingUnless not suitable, these codes SHALL be taken from eCH-010 Address Line Type
            (extensible to http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype)

            A set of codes advising a system or user which name in a set of names to select for a given purpose.

            Typecode
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Fixed ValueaddressLine1
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            30. Address.line.extension:addressLine2
            Slice NameaddressLine2
            Definition

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

            ShortExtension
            Control0..1
            This element is affected by the following invariants: ele-1
            TypeExtension(Address Line Type) (Extension Type: code)
            Is Modifierfalse
            Summaryfalse
            Invariantsele-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.

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            34. Address.line.extension:addressLine2.extension
            Definition

            An Extension

            ShortExtension
            Control0..0
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            SlicingThis element introduces a set of slices on Address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 36. Address.line.extension:addressLine2.url
              Definition

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

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

              Control1..1
              Typeuri
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              Fixed Valuehttp://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).

              ShortValue of extension
              Control1..1
              Typecode
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              SlicingThis element introduces a set of slices on Address.line.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
              • type @ $this
              • 40. Address.line.extension:addressLine2.value[x]:valueCode
                Slice NamevalueCode
                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).

                ShortValue of extension
                Control1..1
                BindingUnless not suitable, these codes SHALL be taken from eCH-010 Address Line Type
                (extensible to http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype)

                A set of codes advising a system or user which name in a set of names to select for a given purpose.

                Typecode
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summaryfalse
                Fixed ValueaddressLine2
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                42. Address.line.extension:street
                Slice Namestreet
                Definition

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

                ShortExtension
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Address Line Type) (Extension Type: code)
                Is Modifierfalse
                Summaryfalse
                Invariantsele-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.

                ShortUnique id for inter-element referencing
                Control0..1
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                46. Address.line.extension:street.extension
                Definition

                An Extension

                ShortExtension
                Control0..0
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                SlicingThis element introduces a set of slices on Address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 48. Address.line.extension:street.url
                  Definition

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

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

                  Control1..1
                  Typeuri
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  Fixed Valuehttp://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).

                  ShortValue of extension
                  Control1..1
                  Typecode
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  SlicingThis element introduces a set of slices on Address.line.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                  • type @ $this
                  • 52. Address.line.extension:street.value[x]:valueCode
                    Slice NamevalueCode
                    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).

                    ShortValue of extension
                    Control1..1
                    BindingUnless not suitable, these codes SHALL be taken from eCH-010 Address Line Type
                    (extensible to http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype)

                    A set of codes advising a system or user which name in a set of names to select for a given purpose.

                    Typecode
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summaryfalse
                    Fixed Valuestreet
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    54. Address.line.extension:streetName
                    Slice NamestreetName
                    Definition

                    streetName.

                    Shortstreet part of the street line, e.g. withouth housenumber
                    Control0..1
                    This element is affected by the following invariants: ele-1
                    TypeExtension(ADXP Street Name) (Extension Type: string)
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-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 NamehouseNumber
                    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.

                    ShorthouseNumber part of the street line
                    Control0..1
                    This element is affected by the following invariants: ele-1
                    TypeExtension(ADXP House Number) (Extension Type: string)
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-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 NameunitID
                    Definition

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

                    ShortunitID, dwellingNumber part of the street line
                    Control0..1
                    This element is affected by the following invariants: ele-1
                    TypeExtension(ADXP Unit ID) (Extension Type: string)
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-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 NamepostOfficeBoxText
                    Definition

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

                    ShortPostbox addresses need an postbox text and optional postbox number
                    Control0..1
                    This element is affected by the following invariants: ele-1
                    TypeExtension(Address Line Type) (Extension Type: code)
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-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.

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    64. Address.line.extension:postOfficeBoxText.extension
                    Definition

                    An Extension

                    ShortExtension
                    Control0..0
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    SlicingThis element introduces a set of slices on Address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 66. Address.line.extension:postOfficeBoxText.url
                      Definition

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

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

                      Control1..1
                      Typeuri
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      Fixed Valuehttp://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).

                      ShortValue of extension
                      Control1..1
                      Typecode
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      SlicingThis element introduces a set of slices on Address.line.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                      • type @ $this
                      • 70. Address.line.extension:postOfficeBoxText.value[x]:valueCode
                        Slice NamevalueCode
                        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).

                        ShortValue of extension
                        Control1..1
                        BindingUnless not suitable, these codes SHALL be taken from eCH-010 Address Line Type
                        (extensible to http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype)

                        A set of codes advising a system or user which name in a set of names to select for a given purpose.

                        Typecode
                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Fixed ValuepostOfficeBoxText
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        72. Address.line.extension:postOfficeBoxNumber
                        Slice NamepostOfficeBoxNumber
                        Definition

                        A numbered box located in a post station.

                        ShortOptional postOfficeBoxNumber as a separate part of the postOfficeBoxText
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(ADXP Post Box) (Extension Type: string)
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-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

                        ShortPrimitive value for string
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        Max Length:1048576
                        76. Address.city
                        Definition

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

                        ShortName of city, town etc.
                        Control1..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Alternate NamesMunicpality
                        ExampleGeneral: Erewhon
                        Invariantsele-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)

                        Shortxml:id (or equivalent in JSON)
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        80. Address.city.extension
                        Definition

                        An Extension

                        ShortExtension
                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        SlicingThis element introduces a set of slices on Address.city.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 82. Address.city.extension:bfs
                          Slice Namebfs
                          Definition

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

                          ShortExtension
                          Control0..1
                          This element is affected by the following invariants: ele-1
                          TypeExtension(eCH-0007 Municipality Id – BFS Gemeindenummer) (Extension Type: string)
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-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

                          ShortPrimitive value for string
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          Max Length:1048576
                          86. Address.district
                          Definition

                          The name of the administrative area (county).

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

                          Control0..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Alternate NamesCounty
                          ExampleGeneral: Madison
                          Invariantsele-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).

                          ShortSub-unit of country (abbreviations ok)
                          Control0..1
                          BindingFor example codes, see eCH-0007 Canton Abbreviation
                          (example to http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation)

                          Use these values for a Swiss or Liechtenstein address

                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Alternate NamesProvince, Territory
                          Invariantsele-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.

                          ShortPostal code for area
                          Control1..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Alternate NamesZip
                          ExampleGeneral: 9132
                          Invariantsele-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.

                          ShortCountry (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.

                          Control1..1
                          BindingThe codes SHOULD be taken from BFS Verzeichnis der Staaten und Gebiete
                          (preferred to http://fhir.ch/ig/ch-term/ValueSet/bfs-country-codes)
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Invariantsele-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)

                          Shortxml:id (or equivalent in JSON)
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          96. Address.country.extension
                          Definition

                          An Extension

                          ShortExtension
                          Control0..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          SlicingThis element introduces a set of slices on Address.country.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 98. Address.country.extension:countrycode
                            Slice Namecountrycode
                            Definition

                            BFS defines the valid set of countries. Values are from the 'ISO 3166-1 country codes' code system.

                            ShortISO Country Alpha-2 or ISO Country Alpha-3 code
                            Control0..1
                            This element is affected by the following invariants: ele-1
                            TypeExtension(Coded string) (Extension Type: Coding)
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-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.extension:countrycode.id
                            Definition

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

                            ShortUnique id for inter-element referencing
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            102. Address.country.extension:countrycode.extension
                            Definition

                            An Extension

                            ShortExtension
                            Control0..0
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            SlicingThis element introduces a set of slices on Address.country.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 104. Address.country.extension:countrycode.url
                              Definition

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

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

                              Control1..1
                              Typeuri
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-codedString
                              106. Address.country.extension:countrycode.value[x]
                              Definition

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

                              ShortValue of extension
                              Control1..1
                              BindingUnless not suitable, these codes SHALL be taken from BFS Verzeichnis der Staaten und Gebiete
                              (extensible to http://fhir.ch/ig/ch-term/ValueSet/bfs-country-codes)
                              TypeCoding
                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              108. Address.country.value
                              Definition

                              The actual value

                              ShortPrimitive value for string
                              Control0..1
                              Typestring
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              Max Length:1048576
                              110. Address.period
                              Definition

                              Time period when address was/is in use.

                              ShortTime period when address was/is in use
                              Control0..0
                              TypePeriod
                              Is Modifierfalse
                              Summarytrue
                              Requirements

                              Allows addresses to be placed in historical context.

                              ExampleGeneral: { "start" : "2010-03-23", "end" : "2010-07-01" }
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))