Polska specyfikacja bazowa HL7 FHIR (HL7 FHIR PL Base)
0.1.2 - ci-build

Polska specyfikacja bazowa HL7 FHIR (HL7 FHIR PL Base), published by HL7 Poland. This guide is not an authorized publication; it is the continuous build for version 0.1.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-Poland/pl-fhir-base/ and changes regularly. See the Directory of published versions

Data Type Profile: PLBaseAddress - Detailed Descriptions

Draft as of 2025-09-03

Definitions for the pl-base-address 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. The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.

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..*
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Address.extension:teryt
Slice Nameteryt
Definition

Kod TERYT

ShortAddress: TERYT Code (PL)
Control0..1
TypeExtension(Address: TERYT Code (PL)) (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.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|5.0.0
(required to http://hl7.org/fhir/ValueSet/address-use|5.0.0)

The use of an address (home / work / etc.).

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

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()))
8. 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 managable, 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.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

    streetName.

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

    ShorthouseNumber
    Control0..*
    TypeExtension(ADXP House Number) (Extension Type: string)
    Is Modifierfalse
    Must Supporttrue
    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())
    14. 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
    Control0..*
    TypeExtension(ADXP Unit ID) (Extension Type: string)
    Is Modifierfalse
    Must Supporttrue
    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())
    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
    Must Supporttrue
    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())
    18. Address.country
    Definition

    Country - a nation as commonly understood or generally accepted.

    ShortCountry (e.g. may be ISO 3166 2 or 3 letter code)
    Comments

    ISO 3166 2- or 3- letter codes MAY 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()))
    20. Address.country.extension
    Definition

    An Extension


    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.country.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 22. Address.country.extension:isoAlpha3CountryCode
      Slice NameisoAlpha3CountryCode
      Definition

      Trzyliterowy kod kraju wg ISO 3166

      ShortAddress: ISO Alpha-3 Country Code
      Control0..1
      TypeExtension(Address: ISO Alpha-3 Country Code) (Extension Type: Coding)
      Is Modifierfalse
      Must Supporttrue
      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())
      24. Address.country.extension:isoNumericCountryCode
      Slice NameisoNumericCountryCode
      Definition

      Numeryczny kod kraju wg ISO 3166

      ShortAddress: ISO Numeric Country Code
      Control0..1
      TypeExtension(Address: ISO Numeric Country Code) (Extension Type: Coding)
      Is Modifierfalse
      Must Supporttrue
      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())

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

      0. Address
      2. Address.extension:teryt
      Slice Nameteryt
      Control0..1
      TypeExtension(Address: TERYT Code (PL)) (Complex Extension)
      4. Address.line
      6. 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
      • 8. Address.line.extension:streetName
        Slice NamestreetName
        Control0..*
        TypeExtension(ADXP Street Name) (Extension Type: string)
        Must Supporttrue
        10. Address.line.extension:houseNumber
        Slice NamehouseNumber
        Control0..*
        TypeExtension(ADXP House Number) (Extension Type: string)
        Must Supporttrue
        12. Address.line.extension:unitID
        Slice NameunitID
        Control0..*
        TypeExtension(ADXP Unit ID) (Extension Type: string)
        Must Supporttrue
        14. Address.line.extension:postBox
        Slice NamepostBox
        Control0..*
        TypeExtension(ADXP Post Box) (Extension Type: string)
        Must Supporttrue
        16. Address.country
        18. Address.country.extension
        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
        • 20. Address.country.extension:isoAlpha3CountryCode
          Slice NameisoAlpha3CountryCode
          Control0..1
          TypeExtension(Address: ISO Alpha-3 Country Code) (Extension Type: Coding)
          Must Supporttrue
          22. Address.country.extension:isoNumericCountryCode
          Slice NameisoNumericCountryCode
          Control0..1
          TypeExtension(Address: ISO Numeric Country Code) (Extension Type: Coding)
          Must Supporttrue

          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. The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.

          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..*
          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
          This element is affected by the following invariants: ele-1
          Typeid
          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 managable, 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:teryt
            Slice Nameteryt
            Definition

            Kod TERYT

            ShortAddress: TERYT Code (PL)
            Control0..1
            TypeExtension(Address: TERYT Code (PL)) (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.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|5.0.0)

            The use of an address (home / work / etc.).

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

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

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

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

            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
            • 20. Address.line.extension:streetName
              Slice NamestreetName
              Definition

              streetName.

              ShortstreetName
              Control0..*
              TypeExtension(ADXP Street Name) (Extension Type: string)
              Is Modifierfalse
              Must Supporttrue
              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())
              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
              Must Supporttrue
              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())
              24. 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
              Control0..*
              TypeExtension(ADXP Unit ID) (Extension Type: string)
              Is Modifierfalse
              Must Supporttrue
              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())
              26. 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
              Must Supporttrue
              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())
              28. 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
              30. 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
              ExampleGeneral: Erewhon
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              32. 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()))
              34. 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()))
              36. 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
              ExampleGeneral: 9132
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              38. Address.country
              Definition

              Country - a nation as commonly understood or generally accepted.

              ShortCountry (e.g. may be ISO 3166 2 or 3 letter code)
              Comments

              ISO 3166 2- or 3- letter codes MAY 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()))
              40. 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
              42. 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
              • 44. Address.country.extension:isoAlpha3CountryCode
                Slice NameisoAlpha3CountryCode
                Definition

                Trzyliterowy kod kraju wg ISO 3166

                ShortAddress: ISO Alpha-3 Country Code
                Control0..1
                TypeExtension(Address: ISO Alpha-3 Country Code) (Extension Type: Coding)
                Is Modifierfalse
                Must Supporttrue
                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())
                46. Address.country.extension:isoNumericCountryCode
                Slice NameisoNumericCountryCode
                Definition

                Numeryczny kod kraju wg ISO 3166

                ShortAddress: ISO Numeric Country Code
                Control0..1
                TypeExtension(Address: ISO Numeric Country Code) (Extension Type: Coding)
                Is Modifierfalse
                Must Supporttrue
                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())
                48. 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
                50. 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.

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