2.2.0-test - ci-build Norway flag

Publication Build: This will be filled in by the publication tooling

Data Type Profile: NoBasisAddress - Detailed Descriptions

Active as of 2019-05-15

Definitions for the no-basis-Address data type profile.

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

0. Address
2. Address.extension:official
Slice Nameofficial
Control0..*
TypeExtension(no-basis-address-official) (Extension Type: boolean)
Alternate Namesoffisiell adresse, user content
4. Address.extension:urbanDistrict
Slice NameurbanDistrict
Definition

The name and number of the of the urban district of this address.

Shorturban district information
Control0..1
TypeExtension(no-basis-urban-district) (Extension Type: Coding)
6. Address.extension:propertyInformation
Slice NamepropertyInformation
Definition

Identification of a real property in Norway is defined using gårdsnummer, bruksnummer and kommunenummer. In addition real property can be rented out, the area of the real property that is rented is measured and is further identified by its festenummer. In addition some real property is split into sections identified by its seksjonsnummer

ShortReal property identification
Control0..*
TypeExtension(no-basis-propertyinformation) (Complex Extension)
8. Address.use
Definition

The purpose of this address.

Mapping of values to other Norwegian CodeSystems is documented in the implementation guide. In general the address used for visiting the person should have use "home" and type "physical" or "both". The "official" flag can be either true or false.

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.

Mapping of values to other Norwegian CodeSystems is documented in the implementation guide. In general the address used for visiting the person should have use "home" and type "physical" or "both". The "official" flag can be either true or false.

12. Address.city
Definition

When a postalcode is given the name of the city must be according to the official list of postalcodes used in Norway.

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

ShortPoststed or city
Alternate Namesby, poststed
14. Address.district
Definition

Name of the county (norwegian "kommune").

The name of the administrative area (county).

Shortname of "kommune"
Alternate Nameskommune
16. Address.district.extension
SlicingThis element introduces a set of slices on Address.district.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 18. Address.district.extension:municipalitycode
    Slice Namemunicipalitycode
    Definition

    Coded value for municipality/county Norwegian kommune

    ShortCoded value for municipality/county Norwegian kommune
    Control0..1
    TypeExtension(no-basis-municipalitycode) (Extension Type: Coding)
    20. Address.state
    Definition

    Name of the norwegian "fylke"). If fylkes-number is required "eiendomsinformasjon" should be used with koded kommune-number.

    Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes).

    Shortnorwegian "fylke"
    Alternate Namesfylke, Territory
    22. Address.postalCode
    Definition

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

    In Norway this is af four digit number defined by the norwegian postal service.

    Alternate Namespostnummer

    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:official
    Slice Nameofficial
    Definition

    Defines the concept of an officially registered address in Norway. Usually this will be the adress registered in "Folkeregisteret" for persons or "Enhetsregisteret" for organizations.

    ShortThe concept of an officially registered address
    Control0..*
    TypeExtension(no-basis-address-official) (Extension Type: boolean)
    Is Modifierfalse
    Summaryfalse
    Alternate Namesoffisiell adresse, 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())
    4. Address.extension:urbanDistrict
    Slice NameurbanDistrict
    Definition

    The name and number of the of the urban district of this address.

    Shorturban district information
    Control0..1
    TypeExtension(no-basis-urban-district) (Extension Type: Coding)
    Is Modifierfalse
    Summaryfalse
    Alternate Namesbydel, urban district
    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.extension:propertyInformation
    Slice NamepropertyInformation
    Definition

    Identification of a real property in Norway is defined using gårdsnummer, bruksnummer and kommunenummer. In addition real property can be rented out, the area of the real property that is rented is measured and is further identified by its festenummer. In addition some real property is split into sections identified by its seksjonsnummer

    ShortReal property identification
    Control0..*
    TypeExtension(no-basis-propertyinformation) (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.

    Mapping of values to other Norwegian CodeSystems is documented in the implementation guide. In general the address used for visiting the person should have use "home" and type "physical" or "both". The "official" flag can be either true or false.


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

    Mapping of values to other Norwegian CodeSystems is documented in the implementation guide. In general the address used for visiting the person should have use "home" and type "physical" or "both". The "official" flag can be either true or false.


    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 AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1
    (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

    The type of an address (physical / postal).

    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    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.city
    Definition

    When a postalcode is given the name of the city must be according to the official list of postalcodes used in Norway.

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


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

    ShortPoststed or cityName 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, by, poststed
    Example<br/><b>General</b>:Erewhon
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. Address.district
    Definition

    Name of the county (norwegian "kommune").

    The name of the administrative area (county).


    The name of the administrative area (county).

    Shortname of "kommune"District 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, kommune
    Example<br/><b>General</b>:Madison
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Address.district.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.district.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 18. Address.district.extension:municipalitycode
      Slice Namemunicipalitycode
      Definition

      Coded value for municipality/county Norwegian kommune

      ShortCoded value for municipality/county Norwegian kommune
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(no-basis-municipalitycode) (Extension Type: Coding)
      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())
      20. Address.state
      Definition

      Name of the norwegian "fylke"). If fylkes-number is required "eiendomsinformasjon" should be used with koded kommune-number.

      Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes).


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

      Shortnorwegian "fylke"Sub-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, fylke
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      22. Address.postalCode
      Definition

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

      In Norway this is af four digit number defined by the norwegian postal service.


      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, postnummer
      Example<br/><b>General</b>:9132
      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:official
        Slice Nameofficial
        Definition

        Defines the concept of an officially registered address in Norway. Usually this will be the adress registered in "Folkeregisteret" for persons or "Enhetsregisteret" for organizations.

        ShortThe concept of an officially registered address
        Control0..*
        TypeExtension(no-basis-address-official) (Extension Type: boolean)
        Is Modifierfalse
        Summaryfalse
        Alternate Namesoffisiell adresse, 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())
        8. Address.extension:urbanDistrict
        Slice NameurbanDistrict
        Definition

        The name and number of the of the urban district of this address.

        Shorturban district information
        Control0..1
        TypeExtension(no-basis-urban-district) (Extension Type: Coding)
        Is Modifierfalse
        Summaryfalse
        Alternate Namesbydel, urban district
        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.extension:propertyInformation
        Slice NamepropertyInformation
        Definition

        Identification of a real property in Norway is defined using gårdsnummer, bruksnummer and kommunenummer. In addition real property can be rented out, the area of the real property that is rented is measured and is further identified by its festenummer. In addition some real property is split into sections identified by its seksjonsnummer

        ShortReal property identification
        Control0..*
        TypeExtension(no-basis-propertyinformation) (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())
        12. Address.use
        Definition

        The purpose of this address.

        Mapping of values to other Norwegian CodeSystems is documented in the implementation guide. In general the address used for visiting the person should have use "home" and type "physical" or "both". The "official" flag can be either true or false.

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

        Mapping of values to other Norwegian CodeSystems is documented in the implementation guide. In general the address used for visiting the person should have use "home" and type "physical" or "both". The "official" flag can be either true or false.

        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()))
        16. 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()))
        18. 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
        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()))
        20. Address.city
        Definition

        When a postalcode is given the name of the city must be according to the official list of postalcodes used in Norway.

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

        ShortPoststed or city
        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Alternate NamesMunicpality, by, poststed
        Example<br/><b>General</b>:Erewhon
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        22. Address.district
        Definition

        Name of the county (norwegian "kommune").

        The name of the administrative area (county).

        Shortname of "kommune"
        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, kommune
        Example<br/><b>General</b>:Madison
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        24. Address.district.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
        26. Address.district.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.district.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 28. Address.district.extension:municipalitycode
          Slice Namemunicipalitycode
          Definition

          Coded value for municipality/county Norwegian kommune

          ShortCoded value for municipality/county Norwegian kommune
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(no-basis-municipalitycode) (Extension Type: Coding)
          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.district.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
          32. Address.state
          Definition

          Name of the norwegian "fylke"). If fylkes-number is required "eiendomsinformasjon" should be used with koded kommune-number.

          Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes).

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

          In Norway this is af four digit number defined by the norwegian 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, postnummer
          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.

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