IL Core Implementation Guide
0.18.0 - draft Israel flag

This page is part of the IL-Core IG (v0.18.0: draft-1 Draft) 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: ILCoreAddress - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 1

Definitions for the il-core-address data type profile.

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

0. Address
2. Address.extension:geolocation
Slice Namegeolocation
Definition

An absolute geographic location

Shortgeolocation
Control0..1
TypeExtension(Geolocation) (Complex Extension)
4. Address.extension:statArea
Slice NamestatArea
Definition

Extension: Statistical Area. Subdivisions of cities for statistical purposes

ShortExtension: Statistical Area
Control0..*
TypeExtension(Ext: Statistical Area) (Extension Type: Identifier)
6. Address.line
Must Supporttrue
Example<br/><b>Valid Example</b>:הירקון 1א' דירה 4 תל אביב
8. Address.line.extension
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
    Definition

    The street name of the address

    ShortExtension: street name
    Control0..1
    TypeExtension(ADXP Street Name) (Extension Type: string)
    Must Supporttrue
    12. 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.

    ShortExtension: house number
    Control0..1
    TypeExtension(ADXP House Number) (Extension Type: string)
    Must Supporttrue
    14. Address.line.extension:buildingNumberSuffix
    Slice NamebuildingNumberSuffix
    Definition

    The building suffix (כניסה)

    ShortExtension: building suffix
    Control0..1
    TypeExtension(ADXP Building Number Suffix) (Extension Type: string)
    16. Address.line.extension:unitId
    Slice NameunitId
    Definition

    The unit ID e.g., Apt#, Room

    Shortunit id
    Control0..1
    TypeExtension(ADXP Unit ID) (Extension Type: string)
    18. Address.line.extension:postBox
    Slice NamepostBox
    Definition

    The post box number of the address

    ShortExtension: post box
    Control0..1
    TypeExtension(ADXP Post Box) (Extension Type: string)
    20. Address.city
    Must Supporttrue
    Example<br/><b>Valid Example</b>:ירושלים
    22. Address.city.extension
    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
    • 24. Address.city.extension:cityCode
      Slice NamecityCode
      Definition

      A coded representation of the city, town or settlement

      Shortcity code
      Control0..1
      TypeExtension(Ext: City Code) (Extension Type: CodeableConcept)
      26. Address.postalCode
      Must Supporttrue
      Example<br/><b>Valid Example</b>:6964101
      28. Address.country
      BindingThe codes SHALL be taken from Country Codes
      (required to http://fhir.health.gov.il/ValueSet/il-core-jurisdiction)
      30. Address.period
      Must Supporttrue

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

      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:geolocation
      Slice Namegeolocation
      Definition

      An absolute geographic location

      Shortgeolocation
      Comments

      The extension can be further extended to include unique geolocation identifiers, confidence, altitude, etc.

      Control0..1
      TypeExtension(Geolocation) (Complex Extension)
      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())
      4. Address.extension:statArea
      Slice NamestatArea
      Definition

      Extension: Statistical Area. Subdivisions of cities for statistical purposes

      ShortExtension: Statistical Area
      Control0..*
      TypeExtension(Ext: Statistical Area) (Extension Type: Identifier)
      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.

      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
      Must Supporttrue
      Summarytrue
      Example<br/><b>General</b>:137 Nowhere Street <br/><b>Valid Example</b>:הירקון 1א' דירה 4 תל אביב
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      10. Address.line.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..*
      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

        The street name of the address

        ShortExtension: street name
        Control0..1
        TypeExtension(ADXP Street Name) (Extension Type: string)
        Is Modifierfalse
        Must Supporttrue
        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.

        ShortExtension: house number
        Control0..1
        TypeExtension(ADXP House Number) (Extension Type: string)
        Is Modifierfalse
        Must Supporttrue
        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:buildingNumberSuffix
        Slice NamebuildingNumberSuffix
        Definition

        The building suffix (כניסה)

        ShortExtension: building suffix
        Control0..1
        TypeExtension(ADXP Building Number Suffix) (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.line.extension:unitId
        Slice NameunitId
        Definition

        The unit ID e.g., Apt#, Room

        Shortunit id
        Control0..1
        TypeExtension(ADXP Unit ID) (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())
        20. Address.line.extension:postBox
        Slice NamepostBox
        Definition

        The post box number of the address

        ShortExtension: post box
        Control0..1
        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())
        22. 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
        Must Supporttrue
        Summarytrue
        Alternate NamesMunicpality
        Example<br/><b>General</b>:Erewhon <br/><b>Valid Example</b>:ירושלים
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        24. Address.city.extension
        Definition

        An Extension


        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

          A coded representation of the city, town or settlement

          Shortcity code
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Ext: City Code) (Extension Type: CodeableConcept)
          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())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          28. 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
          Must Supporttrue
          Summarytrue
          Alternate NamesZip
          Example<br/><b>General</b>:9132 <br/><b>Valid Example</b>:6964101
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          30. 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.

          Control0..1
          BindingThe codes SHALL be taken from For codes, see Country Codes
          (required to http://fhir.health.gov.il/ValueSet/il-core-jurisdiction)
          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()))
          32. Address.period
          Definition

          Time period when address was/is in use.

          ShortTime period when address was/is in use
          Control0..1
          TypePeriod
          Is Modifierfalse
          Must Supporttrue
          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()))

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

          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

          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.extension:geolocation
            Slice Namegeolocation
            Definition

            An absolute geographic location

            Shortgeolocation
            Comments

            The extension can be further extended to include unique geolocation identifiers, confidence, altitude, etc.

            Control0..1
            TypeExtension(Geolocation) (Complex Extension)
            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())
            8. Address.extension:statArea
            Slice NamestatArea
            Definition

            Extension: Statistical Area. Subdivisions of cities for statistical purposes

            ShortExtension: Statistical Area
            Control0..*
            TypeExtension(Ext: Statistical Area) (Extension Type: Identifier)
            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())
            10. 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()))
            12. 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()))
            14. 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()))
            16. 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
            Must Supporttrue
            Summarytrue
            Example<br/><b>General</b>:137 Nowhere Street <br/><b>Valid Example</b>:הירקון 1א' דירה 4 תל אביב
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            18. 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
            20. 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 areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 22. Address.line.extension:streetName
              Slice NamestreetName
              Definition

              The street name of the address

              ShortExtension: street name
              Control0..1
              TypeExtension(ADXP Street Name) (Extension Type: string)
              Is Modifierfalse
              Must Supporttrue
              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: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.

              ShortExtension: house number
              Control0..1
              TypeExtension(ADXP House Number) (Extension Type: string)
              Is Modifierfalse
              Must Supporttrue
              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.extension:buildingNumberSuffix
              Slice NamebuildingNumberSuffix
              Definition

              The building suffix (כניסה)

              ShortExtension: building suffix
              Control0..1
              TypeExtension(ADXP Building Number Suffix) (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())
              28. Address.line.extension:unitId
              Slice NameunitId
              Definition

              The unit ID e.g., Apt#, Room

              Shortunit id
              Control0..1
              TypeExtension(ADXP Unit ID) (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())
              30. Address.line.extension:postBox
              Slice NamepostBox
              Definition

              The post box number of the address

              ShortExtension: post box
              Control0..1
              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())
              32. 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
              34. 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
              Must Supporttrue
              Summarytrue
              Alternate NamesMunicpality
              Example<br/><b>General</b>:Erewhon <br/><b>Valid Example</b>:ירושלים
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              36. 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
              38. 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
              • 40. Address.city.extension:cityCode
                Slice NamecityCode
                Definition

                A coded representation of the city, town or settlement

                Shortcity code
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Ext: City Code) (Extension Type: CodeableConcept)
                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())
                42. 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
                44. 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()))
                46. 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()))
                48. 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
                Must Supporttrue
                Summarytrue
                Alternate NamesZip
                Example<br/><b>General</b>:9132 <br/><b>Valid Example</b>:6964101
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                50. 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.

                Control0..1
                BindingThe codes SHALL be taken from Country Codes
                (required to http://fhir.health.gov.il/ValueSet/il-core-jurisdiction)
                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()))
                52. Address.period
                Definition

                Time period when address was/is in use.

                ShortTime period when address was/is in use
                Control0..1
                TypePeriod
                Is Modifierfalse
                Must Supporttrue
                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()))