eHealth Platform Federal Core Profiles
2.1.2 - STU1 Belgium flag

This page is part of the HL7 Belgium FHIR Implementation Guide - Core profiles (v2.1.2: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Data Type Profile: BeAddress - Detailed Descriptions

Active as of 2024-08-30

Definitions for the be-address data type profile.

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

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

Special remarks for KMEHR users:

Note when .use and .type are used they SHALL use the FHIR defined valuesets as per their required binding level in the FHIR specification. In a KMEHR address, the use was defined by CD-ADDRESS but those values can be found in the FHIR valueset. KMEHR values 'careadress', 'other' and 'vacation' are not directly present in the FHIR address-use table but can be mapped to the value 'temp' in FHIR. In those cases, it is RECOMMENDED to also add a .period. In KMEHR, an address might be expressed using free text or a totally structured approach where the streetname and housenumber are put in separate fields. FHIR prefers a more pragmatic approach where the ‘text’ element is used to print on labels. Also, streetname and number are not separate fields as in KMEHR but in a structural approach are given as one or moren ‘line’ elements. It is however RECOMMENDED to use the Streetname, Housenumber and Postbox extensions to express them seperately. Note the FHIR address also allows to optionally define whether the address is a physical, postal or ‘both’ address using the .type field.

2. Address.extension
Definition

The Human Language of the item. Can be used to express the same address in multiple languages (e.g. in a Brussels setting)

4. Address.extension:language
Slice Namelanguage
Control0..1
TypeExtension(Human Language) (Extension Type: code)
6. 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. It is always RECOMMENDED to give these elements seperately using the defined extensions.

8. Address.line.extension
Definition

RECOMMENDED to use these extensions to define address elements.

SlicingThis element introduces a set of slices on Address.line.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 10. Address.line.extension:Streetname
    Slice NameStreetname
    Control0..*
    TypeExtension(ADXP Street Name) (Extension Type: string)
    12. Address.line.extension:Housenumber
    Slice NameHousenumber
    Control0..*
    TypeExtension(ADXP House Number) (Extension Type: string)
    14. Address.line.extension:Postbox
    Slice NamePostbox
    Control0..*
    TypeExtension(ADXP Post Box) (Extension Type: string)
    16. Address.country
    Definition

    Country - a nation as commonly understood or generally accepted. Concerning the codification of the country, the FHIR specification defines its country field as a string and suggests using a ISO 3166 2 or 3 letter codes. As that 2-letter format is also the standard in a KMEHR address, it is hence RECOMMENDED to codify the country in the same way as in KMEHR.

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

    0. Address
    Definition

    An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

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

    Special remarks for KMEHR users:

    Note when .use and .type are used they SHALL use the FHIR defined valuesets as per their required binding level in the FHIR specification. In a KMEHR address, the use was defined by CD-ADDRESS but those values can be found in the FHIR valueset. KMEHR values 'careadress', 'other' and 'vacation' are not directly present in the FHIR address-use table but can be mapped to the value 'temp' in FHIR. In those cases, it is RECOMMENDED to also add a .period. In KMEHR, an address might be expressed using free text or a totally structured approach where the streetname and housenumber are put in separate fields. FHIR prefers a more pragmatic approach where the ‘text’ element is used to print on labels. Also, streetname and number are not separate fields as in KMEHR but in a structural approach are given as one or moren ‘line’ elements. It is however RECOMMENDED to use the Streetname, Housenumber and Postbox extensions to express them seperately. Note the FHIR address also allows to optionally define whether the address is a physical, postal or ‘both’ address using the .type field.


    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()))
    2. Address.extension
    Definition

    The Human Language of the item. Can be used to express the same address in multiple languages (e.g. in a Brussels setting)


    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..*
    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
    • 4. Address.extension:language
      Slice Namelanguage
      Definition

      The Human Language of the item.

      ShortHuman Language for the item
      Comments

      This is used where an item may repeat to indicate the language of each repeat.

      Control0..1
      TypeExtension(Human Language) (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())
      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 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.

      Example<br/><b>General</b>:home
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      8. 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. It is always RECOMMENDED to give these elements seperately using the defined extensions.


      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
      Example<br/><b>General</b>:137 Nowhere Street
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      10. Address.line.extension
      Definition

      RECOMMENDED to use these extensions to define address elements.


      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..*
      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())
      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 areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 12. Address.line.extension:Streetname
        Slice NameStreetname
        Definition

        streetName.

        ShortstreetName
        Control0..*
        TypeExtension(ADXP Street Name) (Extension Type: string)
        Is Modifierfalse
        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())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        14. 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
        Control0..*
        TypeExtension(ADXP House Number) (Extension Type: string)
        Is Modifierfalse
        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())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        16. Address.line.extension:Postbox
        Slice NamePostbox
        Definition

        A numbered box located in a post station.

        ShortpostBox
        Control0..*
        TypeExtension(ADXP Post Box) (Extension Type: string)
        Is Modifierfalse
        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())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        18. Address.country
        Definition

        Country - a nation as commonly understood or generally accepted. Concerning the codification of the country, the FHIR specification defines its country field as a string and suggests using a ISO 3166 2 or 3 letter codes. As that 2-letter format is also the standard in a KMEHR address, it is hence RECOMMENDED to codify the country in the same way as in KMEHR.


        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.

        Control0..1
        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()))

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

        0. Address
        Definition

        An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

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

        Special remarks for KMEHR users:

        Note when .use and .type are used they SHALL use the FHIR defined valuesets as per their required binding level in the FHIR specification. In a KMEHR address, the use was defined by CD-ADDRESS but those values can be found in the FHIR valueset. KMEHR values 'careadress', 'other' and 'vacation' are not directly present in the FHIR address-use table but can be mapped to the value 'temp' in FHIR. In those cases, it is RECOMMENDED to also add a .period. In KMEHR, an address might be expressed using free text or a totally structured approach where the streetname and housenumber are put in separate fields. FHIR prefers a more pragmatic approach where the ‘text’ element is used to print on labels. Also, streetname and number are not separate fields as in KMEHR but in a structural approach are given as one or moren ‘line’ elements. It is however RECOMMENDED to use the Streetname, Housenumber and Postbox extensions to express them seperately. Note the FHIR address also allows to optionally define whether the address is a physical, postal or ‘both’ address using the .type field.

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

        The Human Language of the item. Can be used to express the same address in multiple languages (e.g. in a Brussels setting)

        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.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 6. Address.extension:language
          Slice Namelanguage
          Definition

          The Human Language of the item.

          ShortHuman Language for the item
          Comments

          This is used where an item may repeat to indicate the language of each repeat.

          Control0..1
          TypeExtension(Human Language) (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())
          8. 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.

          Example<br/><b>General</b>:home
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          10. 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 | 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).

          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
          Example<br/><b>General</b>:both
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          12. 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.

          Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          14. 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. It is always RECOMMENDED to give these elements seperately using the defined extensions.

          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
          Example<br/><b>General</b>:137 Nowhere Street
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          16. 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
          18. Address.line.extension
          Definition

          RECOMMENDED to use these extensions to define address elements.

          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 areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 20. Address.line.extension:Streetname
            Slice NameStreetname
            Definition

            streetName.

            ShortstreetName
            Control0..*
            TypeExtension(ADXP Street Name) (Extension Type: string)
            Is Modifierfalse
            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())
            22. 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
            Control0..*
            TypeExtension(ADXP House Number) (Extension Type: string)
            Is Modifierfalse
            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())
            24. Address.line.extension:Postbox
            Slice NamePostbox
            Definition

            A numbered box located in a post station.

            ShortpostBox
            Control0..*
            TypeExtension(ADXP Post Box) (Extension Type: string)
            Is Modifierfalse
            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())
            26. 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
            28. Address.city
            Definition

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

            ShortName of city, town etc.
            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Alternate NamesMunicpality
            Example<br/><b>General</b>:Erewhon
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            30. 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
            Example<br/><b>General</b>:Madison
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            32. 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
            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()))
            34. Address.postalCode
            Definition

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

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

            Country - a nation as commonly understood or generally accepted. Concerning the codification of the country, the FHIR specification defines its country field as a string and suggests using a ISO 3166 2 or 3 letter codes. As that 2-letter format is also the standard in a KMEHR address, it is hence RECOMMENDED to codify the country in the same way as in KMEHR.

            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.

            Control0..1
            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()))
            38. Address.period
            Definition

            Time period when address was/is in use.

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

            Allows addresses to be placed in historical context.

            Example<br/><b>General</b>:{ "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()))